This folder contains all the infrastructure code needed to run
Voilib. It uses some Docker-based services configured with a
Docker Compose file (different in development and in production).
The main commands to build and run all the needed services are in the provided makefile. Run
makefrom infra/ folder to see all of them (although you should read all this guide first).
In development mode (see development/ folder)
frontend and backend code is using a bind
mount so that you don't
need to rebuild the Docker images every time you change something in
the code.
- The compose.yml file expects a
.env.devfile in the ./development/ folder with the needed environment variables. You should create it before building any service, you can copy the provided .env.dev.example.
.env.dev file is created, you can build the Docker images
for all the services with make dev-build (it performs a docker compose build) and run all of them with make dev-run (it performs a
docker compose up). The following services will be available:
- Application frontend at http://localhost (although it won't be ready yet for queries)
- Management Dashboard at http://localhost:8501
- REST API at http://localhost:81/service/
with
Swaggerdocs at http://localhost:81/service/docs Qdrant(vector database) running at http://qdrant:6333 (from the internal Docker network)
ℹ️ Now read first-run tasks section to find how to configure and start adding content to the application.
-
As in development (read that section first), you must create a
.env.prodfile in the ./production/ folder from the provided example: .env.prod.example -
When you do it, ensure to use your own domain in
VITE_API_HOST. Replace it also in the following lines from thecompose.ymlfile (you can search and replacevoilib.comin the file):
- "traefik.http.routers.ui.rule=(Host(`voilib.com`) && PathPrefix(`/`))"- "traefik.http.routers.api.rule=(Host(`voilib.com`) && PathPrefix(`/service`))"...and
- "traefik.http.routers.management.rule=(Host(`voilib.com`) && PathPrefix(`/management`))"-
There are also some references to
voilib.comin traefik.prod.toml that you should replace with your own domain. -
You should change the default
SECRET_KEYprovided in .env.prod.example by running the suggested command, and also theADMIN_PASSWORD.
make prod-build
and make prod-run.
ℹ️ Now read first-run tasks section to find how to configure and start adding content to the application.
The first time you run all the services you will need to perform the following tasks.
ℹ️ In Docker-based installations, Voilib will run migrations automatically from a Docker entrypoint. You can skip this step.
Voilib uses sqlite to store some information about podcasts and
episodes. To ensure the database file with all the needed tables is
created you should run the following command from infra/ folder:
cd development && docker compose --env-file=.env.dev exec backend alembic upgrade head...or this one in production:
cd production && docker compose --env-file=.env.prod exec backend alembic upgrade headℹ️ In Docker-based installations, Voilib will create automatically the admin user. By default, username will be
voilib-adminand password*audio*search*engine, although they can be configured with environment variables. So, you can skip this step.
Open Swagger at and use the /users/signup endpoint to register a
new user. You can use whatever email or password you want but, to
ensure the user is automatically recognized as an admin, you should
use the username voilib-admin.
ℹ️ There is a setting with the name
admin_usernameto tellFastAPIthe username we want to be automatically promoted to admin after sign-up.
There are some API endpoints that can be only used by admin users. You
can check all the available endpoint with Swagger.
ℹ️ This can be also done from Voilib Management Dashboard. From there, you can also add your own audio files to Voilib.
The file urls.json contains the list of podcast that Voilib will collect. By default it contains some examples of popular podcast. You can change this list and add the feeds from all the podcasts you want. I usually use listennotes.com to find the URLs of the RSS feeds of my favorite podcasts.
The following command (run it from from infra/ folder) will start collecting episodes from all the configured feeds:
cd development && docker compose --env-file=.env.dev exec worker voilib-episodes --update...or this one in production:
cd production && docker compose --env-file=.env.prod exec worker voilib-episodes --updateℹ️ You can easily run these tasks from Voilib Management Dashboard.
You can use cron to configure periodic jobs that will
collect, transcript and index new episodes. Here you have
my development configuration (assuming you work in Linux, run crontab -e to modify cron configuration):
# update list of episodes every 6 hours
0 */6 * * * cd /{change-me}/voilib/infra/development && docker compose --env-file=.env.dev exec worker voilib-episodes --update
# transcribe last day episodes every 12 hours
20 */12 * * * cd /{change-me}/accushoot/voilib/infra/development && docker compose --env-file=.env.dev exec worker voilib-episodes --transcribe-days 1
# index pending episodes every 6 hours
40 */6 * * * cd /{change-me}/voilib/infra/development && docker compose --env-file=.env.dev exec worker voilib-episodes --store
...and my production configuration
# update list of episodes every 6 hours
0 */6 * * * cd /{change-me}/voilib/infra/production && docker compose --env-file=.env.prod exec worker voilib-episodes --update
# transcribe last day episodes every 12 hours
20 */12 * * * cd /{change-me}/accushoot/voilib/infra/production && docker compose --env-file=.env.prod exec worker voilib-episodes --transcribe-days 1
# index pending episodes every 6 hours
40 */6 * * * cd /{change-me}/voilib/infra/production && docker compose --env-file=.env.prod exec worker voilib-episodes --storeDon't forget to change all /{change-me} to the actual path that
contains the Voilib repository.