Loading... Background job is running.

On-Premises Installation Guide

Private Packagist Enterprise

Requirements

  1. License Key File (file extension .rli)
    Don't have one yet? Sign up for a free trial license!
  2. One (sub-)domain to operate the web interface, e.g. packagist.myintranet.com
  3. One (sub-)domain to operate the composer repository, e.g. repo.packagist.myintranet.com or packagist-repo.myintranet.com
  4. An SSL certificate valid for both chosen domains
  5. An SMTP server or a GMail account for Private Packagist Enterprise to send email
  6. A Linux Server
    • Linux Kernel 3.10 or greater
    • At least 4GB memory
    • At least 2 CPU cores
    • At least 20GB disk space
    • Ports 443 and 8800 must be accessible
    • Must be reachable at the chosen domain names from your local machine

Installing Replicated

Replicated is the application which will provide you with a management interface to your Private Packagist Enterprise installation and allow you to monitor the task and perform maintenance operations such as backups or updates.

The easiest way to install replicated is the easy install script. You can run it using the following two commands:

curl -sSL -o install.sh https://get.replicated.com/docker/privatepackagist/stable
sudo bash ./install.sh

Alternatively you can manually install the required tools and services, you can install Replicated onto a machine that is not connected to the internet, or you can install Replicated in an existing Kubernetes cluster.

To learn more about the different methods of Installing Replicated and options for the easy install script, please refer to the Replicated manual on Installing the application at https://www.replicated.com/docs/distributing-an-application/installing/.

Replicated Configuration

Replicated Setup

Once Replicated’s services are installed on your server you need to access the management console on your browser. It’s available via SSL on port 8800. So open https://packagist.myintranet.com:8800/ in your browser (replace the domain with your own). You will have to proceed despite the security warning (since your certificate is still missing).

Upload your SSL certificate on the next screen. SSL should work correctly from the next page.

On the next screen you can upload the supplied .rli license key file.

Once validated, you will be asked to set a password for the management console or to protect it with a different authentication mechanism.

Server Settings

In the management console you will have to configure a few options before you can start the Private Packagist Enterprise application.

E-mail

Select options for your SMTP server or use the GMail option for a simplified form if want to send email through GMail. This step is required to allow Private Packagist to send transactional email to users.

Application Startup

Save and apply the settings to start Private Packagist Enterprise. Leave the Setup mode enabled.

Once the application has started, click on the open link to access the Private Packagist Enterprise Web Interface.

Authentication Setup

Within Private Packagist Enterprise you now need to set up at least one integration with a third party service for user authentication. You can either use your on-premises version of GitHub, Bitbucket, or GitLab, or their public services on github.com, bitbucket.org or gitlab.com. Follow the instructions to create the respective required identifiers, tokens and secrets.

Selecting Admins

After setting up an integration you can login through the top menu. Register an account and pick a username.

The first user is granted admin permissions automatically. You can grant admin permissions to more users in the admin panel.

Switching to Production Mode

Head back to the Replicated management console to disable the Setup Mode in Settings.

Apply the changes and wait while the application restarts.

That’s it! Private Packagist Enterprise is now ready to be used! You’ll find all further information in the web interface.

Maintenance

Backups

Once the application is running you can create a snapshot in the management console using the “Start Snapshot” button. You can view a list of all snapshots created under “Snapshots” when you click on the gear icon on the menu bar. Further you can configure automatic regular snapshots in the “Console Settings” after clicking on the gear icon. We recommend you configure Snapshots to store files via SFTP or on S3 instead of locally to avoid a very slow snapshot process.

Snapshot are stored in /var/lib/replicated/snapshots on the Replicated host. This location may not be suitable for keeping large amounts of data. Additionally, by default, it is likely to be on the same physical volume as all other critical data. We highly recommend this location is configured to be on a separate volume with large capacity to ensure data can be recovered in case of a disaster.

If you ever need to restore the application from a snapshot you need to store it on the host’s hard drive before you start the management console. You can then select a snapshot at the setup step that asks for a license key file. See https://www.replicated.com/docs/kb/supporting-your-customers/restoring-from-a-snapshot/ for screenshots of the process.

Updates

By default Replicated checks for updates every 5 hours and you can install them from the dashboard once they are available. You can configure this behaviour under “Console Settings” when clicking on the gear icon in the management console.

The Private Packagist Enterprise Changelog details all new features, behavior changes and major bugfixes each release introduces.

Free Trial

Login with github now to create an organization and start your free trial!