diff --git a/docs/management.png b/docs/management.png new file mode 100644 index 0000000..c1bcb7e Binary files /dev/null and b/docs/management.png differ diff --git a/readme.md b/readme.md index 9d2e57d..2dc323e 100644 --- a/readme.md +++ b/readme.md @@ -22,14 +22,32 @@ will find related content in thousands of episodes. > src='https://storage.ko-fi.com/cdn/kofi3.png?v=3' border='0' alt='Buy > Me a Coffee at ko-fi.com' /> +![Voilib](./docs/voilib.gif) -▶️ You can run **your own instance** of Voilib in your server, it -doesn't depend on any external paid service. You can start by reading -[deployment docs](./infra/readme.md) and its [first run tasks -section](./infra/readme.md#first-run-tasks). +## ▶️ run your own instance now! +You can run **your own instance** of Voilib in your server, it +doesn't depend on any external paid service. -![Voilib](./docs/voilib.gif) +``` +mkdir voilib && cd "voilib" +curl https://raw.githubusercontent.com/unmonoqueteclea/voilib/main/compose.yml -o compose.yml +docker compose up +``` + +> You will need an admin user and password. By default user +> `voilib-admin` with password `*audio*search*engine*` will be +> created. + +After all services are up, jump to +[http://localhost:8501](http://localhost:8501) and follow the +instructions to populate Voilib with content. You can also check +[first run tasks section](./infra/readme.md#first-run-tasks). + +![Management](./docs/management.png) + +More information about deployments in +[infra/readme](./infra/readme.md). ## ❓ how it works