Docker
A [stable](reaper99/recipya Docker
is produced on every release. An unstable one
is produced nightly whenever the main
branch has new commits.
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 \
--name recipya
--restart unless-stopped
-p 8085:8078 \
-v recipya-data:/root/.config/Recipya \
-e RECIPYA_SERVER_PORT=8078 \
-e RECIPYA_SERVER_URL=http://0.0.0.0 \
reaper99/recipya:nightly
Recipya can be accessed from your host machine at http://localhost:8085.
Updating your container
Run the command below for a quick update with Watchtower.
Remember to replace recipya
with your actual container name if it differs and to back up your volume data..
docker run --rm --volume /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --run-once recipya
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.
Updating your container
Follow these steps to update Recipya. Remember to back up your volume data in case something goes south.
- Pull the latest image
docker compose pull
- Recreate the container with the latest image
docker compose up -d
Environment Variables
Variable | Description |
---|---|
RECIPYA_DI_ENDPOINT | The Endpoint variable displayed in the Keys and endpoint tab of your Azure AI Document Intelligence resource in the Azure Portal. Default: "" . |
RECIPYA_DI_KEY | The KEY 1 variable displayed in the Keys and endpoint tab of your Document Intelligence resource in the Azure Portal. Default: "" . |
RECIPYA_EMAIL | The email address of your SendGrid account. Default: "" . |
RECIPYA_EMAIL_SENDGRID | Your SendGrid API key. The free tier should be sufficient for your needs. Default: "" . |
RECIPYA_SERVER_AUTOLOGIN | Whether to login automatically into the application. Can be true or false .Default: false . |
RECIPYA_SERVER_IS_DEMO | Whether the app is a demo version. Can be true or false .Default: false . |
RECIPYA_SERVER_IS_PROD | Whether the app is in production. Can be true or false .Default: false . |
RECIPYA_SERVER_NO_SIGNUPS | Whether to disable user account registrations. Set to true when you don’t want people to create accounts.Default: false . |
RECIPYA_SERVER_PORT | The port the app will be served through if localhost. Is required. |
RECIPYA_SERVER_URL | The website the app is served on. This URL will serve as the base link in the emails. Is required. |
Deprecations
The following table lists deprecated environment variables in v1.2.0. They will be removed in v1.3.0.
Variable | Reason |
---|---|
RECIPYA_VISION_ENDPOINT | Replaced the use of Azure AI Vision to digitize recipes in favor of Azure AI Document Intelligence. |
RECIPYA_VISION_KEY | Same as above. |