Installing with Docker

You can use docker and docker-compose in order to manage your Plume instance and have it isolated from your host.

If you don’t have docker and docker-compose installed yet, here are their respective installation documentation: docker and docker-compose.

Then use these commands:

mkdir plume
cd plume

# Get the docker-compose configuration and Plume's configuration
curl https://docs.joinplu.me/docker-compose.sample.yml > docker-compose.yml
# If you are on an ARM machine, use the image from the Lollipop Cloud project instead
curl https://docs.joinplu.me/docker-compose.sample.arm32v7.yml > docker-compose.yml
# Or
curl https://docs.joinplu.me/docker-compose.sample.arm64v8.yml > docker-compose.yml


curl https://docs.joinplu.me/docker.sample.env > .env

You should edit the freshly created .env file as it contains the configuration of your Plume instance. The options at the top especially should be modified.

Once it’s done, you can finalize the installation.

# Download the images
docker-compose pull

# Launch the database container
docker-compose up -d postgres
# Create the database role (it will ask you for the password)
docker-compose run --rm postgres su postgres -c createuser plume -dP
# Setup the database (create it and run migrations)
docker-compose run --rm plume diesel database setup

# Setup your instance
docker-compose run --rm plume plm instance new
docker-compose run --rm plume plm users new --admin
docker-compose run --rm plume plm search init

# Launch your instance for good
docker-compose up -d

And that’s it! You can now setup a reverse-proxy to access Plume from other machines than your server (which is probably what you want 😁).

Configure a reverse-proxy