Web-based recipe book.

The easiest method is via docker.

docker run -p 5000:5000 cwmr/gomp

The above command will use the default configuration, which includes using an embedded SQLite database and ephemeral storage, which is not recommended in production. In order to have persistent storage, you can use a bind mount or named volume with the volume exposed by the container at "/var/app/gomp/data".

docker run -p 5000:5000 -v /path/on/host:/var/app/gomp/data cwmr/gomp

The equivalent compose file, this time using a named volume, would look like the following.

version: '2'

volumes:
  data:
services:
  web:
    image: cwmr/gomp
    volumes:
      - data:/var/app/gomp/data
    ports:
      - 5000:5000

The easiest way to deploy with a PostgreSQL database is via docker-compose. An example compose file can be found at the root of this repo and is shown below.

version: '2'

volumes:
  data:
  db-data:
services:
  web:
    image: cwmr/gomp
    depends_on:
      - db
    environment:
      - DATABASE_URL=postgres://dbuser:dbpassword@db/gomp?sslmode=disable
    volumes:
      - data:/var/app/gomp/data
    ports:
      - 5000:5000
  db:
    image: postgres
    environment:
      - POSTGRES_PASSWORD=dbpassword
      - POSTGRES_USER=dbuser
      - POSTGRES_DB=gomp
    volumes:
      - db-data:/var/lib/postgresql/data

You will obviously want to cater the values (e.g., passwords) for your deployment.

TODO

TODO

The following table summarizes the available configuration settings, which are settable through environment variables.

All environment variables can also be prefixed with "GOMP_" (e.g., GOMP_IS_DEVELOPMENT=1) in cases where there is a need to avoid collisions with other applications. The name with "GOMP_" is prefered if both are present.

For values that are releative paths (e.g., BASE_ASSETS_PATH, DATABASE_URL for SQLite, and UPLOAD_PATH for the fs driver), they are always relative to the application working directory. When using docker, this is "/var/app/gomp", so anthing at or below the "data/" relative path is in the exposed "/var/app/gomp/data" volume.

Currently PostgreSQL and SQLite are supported.

make [re]install

make [re]build

make docker

See static/package.json and go.mod