Docker

A Docker image named reaper99/recipya is produced nightly.

You can either install the application using Docker or Docker Compose.

Using Docker

You first have to fetch it.

docker pull reaper99/recipya:nightly

Then, run the image. The -e environment variables are described below.

docker run -d \
  -p [host port]:[port specified in config.json] \
  -v <host-path>:/app/recipya.db \
  -e RECIPYA_EMAIL=my@email.com \
  -e RECIPYA_EMAIL_SENDGRID=API_KEY \
  -e RECIPYA_VISION_KEY=KEY_1 \
  -e RECIPYA_VISION_ENDPOINT=https://{resource}.cognitiveservices.azure.com \
  -e RECIPYA_SERVER_AUTOLOGIN=false \
  -e RECIPYA_SERVER_IS_DEMO=false \
  -e RECIPYA_SERVER_IS_PROD=false \
  -e RECIPYA_SERVER_NO_SIGNUPS=false \
  -e RECIPYA_SERVER_PORT=8078 \
  -e RECIPYA_SERVER_URL=http://0.0.0.0 \
  reaper99/recipya:nightly

Using Docker Compose

You can use Docker Compose to run the container. First, download the compose.yaml file. Modify the environment and ports sections. The environment variables are described below. Then, start the application.

docker-compose up -d

Access the app through your browser at http://localhost:[host port].

If you are using Windows and you intend to access the app on other devices within your home network, please ensure to Allow the connection of the Docker Desktop Backend inbound Windows Defender Firewall rule.

Environment Variables

Variable	Description	Required
RECIPYA_EMAIL	The administrator’s email address. It is usually the email address of your SendGrid account.
RECIPYA_EMAIL_SENDGRID	Your SendGrid API key. The free tier should be sufficient for your needs.
RECIPYA_SERVER_AUTOLOGIN	Whether to login automatically into the application. Set to `true` when you don’t need user accounts.
RECIPYA_SERVER_IS_DEMO	Whether the app is a demo version. Its value can be either `true` or `false`.
RECIPYA_SERVER_IS_PROD	Whether the app is in production. Its value can be either `true` or `false`.
RECIPYA_SERVER_NO_SIGNUPS	Whether to disable user account registrations. Set to `true` when you don’t want people to create accounts.
RECIPYA_SERVER_PORT	The port the app will be served through if localhost.
RECIPYA_SERVER_URL	The website the app is served on. This URL will serve as the base link in the emails.
RECIPYA_VISION_KEY	The KEY 1 variable displayed on the Keys and endpoint tab of your Computer vision resource in the Azure Portal.
RECIPYA_VISION_ENDPOINT	The Endpoint variable displayed on the Keys and endpoint tab of your Computer vision resource in the Azure Portal.

Configuration File Release Build