Installation

Plume Compose

Requirements

• Docker Compose
• Git Version Control
• GNU Make

For a long-term installation we provide Plume Compose as a quick and easy way of getting up and running with a pre-configured Docker Compose configuration.

1. Clone the repository to a location of your choosing

   cd /your/chosen/path/
   git clone [email protected]:PHLAK/plume-compose.git

2. Switch to the plume-compose directory and initialize the configuration files

   cd plume-compose
   make init

3. Modify the environment variables in .env for your installation

4. Run docker compose config to validate and confirm your configuration

5. Run docker compose up -d to start the containers

Docker Compose

Requirements

• Docker Compose

If you prefer a maunal Docker Compose installation you may create a directory for your Plume app and, in that directory, add a docker-compose.yaml file and a folder (e.g. data) to contain your data.

/path/to/plume
├── data
│   └── [your data will go here]
└── docker-compose.yaml

docker-compose.yaml

services:

  plume:
    image: phlak/plume:<version>
    environment:
      # SITE_TITLE: My Amazing Blog
      # TIMEZONE: America/Phoenix
      # See configuration docs for additional variables
    ports:
      - <host_port>:80
    volumes:
      - ./data:/data
    restart: unless-stopped

IMPORTANT

Replace <version> with the version of Plume you'd like to run (e.g. 1.0.5, 1.0 or 1)

Replace <host_port> with the port on which you would like the application to be exposed.

TIP

See Environment Variables for a full list of the available environment variables.

Once created, start the container by running docker compose up -d from the same directory as the docker-compose.yaml file.

Docker Run

Requirements

• Docker

You may alternatively use docker run to launch a stand-alone Docker container from the official Docker image.

This is a good way to test Plume for the first time but is not recommended for long-term use. Instead we recommend using either the Plume Compose or Docker Compose installation method instead.

docker run --detach [--env ENVIRONMENT_VARIABLE=value] \
    --volume <host_path>:/data --publish <host_port>:80 \
    phlak/plume:latest

IMPORTANT

Replace <host_path> with the path to a directory where your posts, pages and additional data will be stored.

Replace <host_port> with the port on which you would like the application to be exposed.

TIP

You may pass multiple environment variables by repeating the --env flag.

Manual Installation

Requirements

• PHP
• A web server capable of serving PHP (e.g NGINX, Apache, etc.)

This is not a recommended installation method

Installing manually will require more work to update between versions.

More details coming soon including examples for

• NGINX
• Apache
• Caddy