Web-based recipe book.

The easiest method is via docker.

docker run -p 5000:5000 ghcr.io/chadweimer/gomp

On a fresh deployment, you can log into the application using the default user "[email protected]" with password "password".

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 ghcr.io/chadweimer/gomp

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

version: '2'

volumes:
  data:
services:
  web:
    image: ghcr.io/chadweimer/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 examples/docker-compose.yml and is shown below.

version: '2'

volumes:
  data:
  db-data:
services:
  web:
    image: ghcr.io/chadweimer/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.

A basic manifest is shown below. This manifest is roughly equivalent to the first docker command shown in the Docker section above, and is thus not recommended for production use.

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app.service: web
  name: web
spec:
  selector:
    matchLabels:
      app.service: web
  template:
    metadata:
      labels:
        app.service: web
    spec:
      containers:
      - image: ghcr.io/chadweimer/gomp
        name: web
        ports:
        - containerPort: 5000
        restartPolicy: Always
---
apiVersion: v1
kind: Service
metadata:
  labels:
    app.service: web
  name: web
spec:
  ports:
  - port: 5000
    targetPort: 5000
  selector:
    app.service: web

🚧 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 allow 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 anything at or below the "data/" relative path is in the exposed "/var/app/gomp/data" volume.

Currently PostgreSQL and SQLite are supported.

This repository uses make. The simplest way to build the entire project is to issue the following command at the root of the repository:

make

The sections below describe additional operations that are available, though it is not a complete list. Refer the the Makefile for more.

make install

The equivalent for uninstalling is make uninstall.

make lint

make build

The equivalent for cleaning is make clean.

make docker

make archive

These archives are deleted (cleaned) by the same clean target as above.

See static/package.json and go.mod