Skip to content

Commit

Permalink
doc: update docs for new self-host options
Browse files Browse the repository at this point in the history
  • Loading branch information
unmonoqueteclea committed Oct 20, 2023
1 parent 9a0e29d commit f1643e7
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
Binary file added docs/management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions infra/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ 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](http://localhost)
(although it won't be ready yet for queries until you populate the
app with content)
- **Management Dashboard** at [http://localhost:8501](http://localhost:8501)
(although it won't be ready yet for queries)
- **REST API** at
[http://localhost/service/](http://localhost/service/) with
Expand Down
28 changes: 23 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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' /></a>
![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 **Voilib Management Dashboard** at
[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
Expand Down

0 comments on commit f1643e7

Please sign in to comment.