Skip to content

Latest commit

 

History

History
73 lines (42 loc) · 2.44 KB

DEPLOYMENT.md

File metadata and controls

73 lines (42 loc) · 2.44 KB
Raw

Deployment with docker

There's only one image to be built:

docker build -f Dockerfile.deployment --tag <repository>:<tag> --build-arg <buildarg1> --build-arg <buildarg2> .

There are several build arguments required:

  • APP_URL
  • DOCS_URL
  • GIT_SHA (build version. Something like "$(date "+%Y%m%d-%H%M%S")-$(git rev-parse HEAD | cut -c1-7)" should work)

Updating image

Run build with --pull --no-cache parameters to ensure latest image and packages are used.

Configuration files

There are three main configuration files which can be mounted to the container:

  • /app/.env: environment file. Can also be done by passing them as environment variables
  • /app/storage/oauth-private.key: OAuth private key. Alternatively can be set using environment variable PASSPORT_PRIVATE_KEY
  • /app/storage/oauth-public.key: OAuth public key for the private key above. Similarly can be an environment variable PASSPORT_PUBLIC_KEY

Note that as the actual process is run as non-root user, the files must be world-readable.

Services

The image built serves multiple purposes, each can be run by passing the parameter when starting docker (or as command if using orchestration tools like docker compose).

There are three main commands:

  • octane: starts octane on port 8000
  • assets: starts nginx on port 8080. Used to serve static assets
  • artisan: starts artisan command. This should be followed by correct options

octane

Command: octane

Serves PHP over HTTP. Connect to it at port 8000 through a reverse proxy like nginx.

static assets

Command: assets

This serves static files using nginx at port 8080. The nginx config file is located at /app/docker/deployment/nginx-assets.conf and can be overridden by mounting.

job runner

Command: artisan queue:work --queue=<queuename> <additional options...>

There are multiple queues used:

  • beatmap_default
  • beatmap_high
  • default
  • notification
  • store-notifications

The names should be relatively self explained. Multiple queues can be handled by single runner by specifying them all separated by comma (ex: default,notification,store-notifications).

Additional options can be checked in this page.

scheduled tasks

Command: artisan schedule:run

This should be run at least every 10 minutes. It doesn't run permanently.

Migration

No migration is run by default. Run the container with command artisan migrate to run the migration.