This is the multi-page printable view of this section. Click here to print.
The app has a docker image that simplifies the deployment. The preferred methods of running the application all revolve around running the Docker image in different ways.
Select the method you want to use to deploy below or if your tool is not listed (for example Portainer), head to the docker page.
If you prefer to run the app manually with docker, you can simply run the following command:
docker run -p 8000:8000 -v $(pwd)/config:/config markbeep/audiobookrequest:1
This will start the container on port 8000 and create the config/ directory in
your current working directory.
The above command might break on Windows. Instead, use
${PWD}\config:/config ... in PowerShell or %cd%\config:/config ... in
Windows Command Prompt.
The :1 at the end denotes the image version.
Check dockerhub for
any other versions you can use instead.
The :latest tag will give you the last non-nightly release, but it is not
recommended incase of changes that are not backwards compatible.
For experimental builds (latest commits in the main branch of the repository),
the :nightly version tag can be used.
Docker-compose works the similar way as Docker.
The basic docker compose file is as follows:
services:
web:
image: markbeep/audiobookrequest:1
ports:
- '8000:8000'
volumes:
- ./config:/config
If you want to add any environment variables, you can add them as explained here. It would look along the lines of this:
services:
web:
image: markbeep/audiobookrequest:1
ports:
- '8000:5432'
volumes:
- ./config:/config
environment:
ABR_APP__PORT: 5432
ABR_APP__OPENAPI_ENABLED: true
Here’s an example for a kubernetes deployment file you’d use:
apiVersion: apps/v1
kind: Deployment
metadata:
name: audiobookrequest
labels:
app: audiobookrequest
spec:
replicas: 1
selector:
matchLabels:
app: audiobookrequest
template:
metadata:
labels:
app: audiobookrequest
spec:
containers:
- name: audiobookrequest
image: markbeep/audiobookrequest:1
imagePullPolicy: Always
volumeMounts:
- mountPath: /config
name: abr-config
ports:
- name: http-request
containerPort: 8000
volumes:
- name: abr-config
hostPath:
path: /mnt/disk/AudioBookRequest/
For the volume you can assign it a host path on a node, or assign it to a PVC.
The bare metal approach should only be the last option. Try to get it working with Docker or get support on the Discord server before trying to set ABR up for a bare metal deployment.
There are no guarantees that if one version works locally that it won’t suddenly break in the next because of a new dependency, new file structure or something else.
To run ABR locally without Docker, the same steps as for the local development have to be followed. First, follow the instructions to get local development working.
Once local development works, there are a few adjustments that have to be made to run the app in production mode instead of debug/local mode.
.env.local file or delete all contents in it.uv run python /app/util/fetch_js.py. This should populate your static/
directory with some new js files.fastapi dev you want to execute fastapi start to start
the webserver..env and place any environment variables you want to
set in there.ABR_APP__PORT), you’ll have to run fastapi with the --port <PORT> flag:
fastapi run --port 5432
With these changes your deployment will be running in production mode.