ewen/rudibridge-mirror
1
0
Fork 0
mirror of https://codeberg.org/Ewen/rudibridge.git synced 2024-12-22 03:02:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: minimal doc for production

Browse source
This commit is contained in:
Ewen 2024-05-14 08:46:59 +02:00
parent 91881fa177
commit b1db8a51a4
2 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
.env.example Normal file
View file

@ -0,0 +1,10 @@
# Frontend configuration
VITE_API_ENDPOINT=http://yourdomain.tld/api/
# Traefik configuration, if needed
TRAEFIK_HOST=yourdomain.tld
TRAEFIK_CERTRESOLVER=letsencrypt
# Backend configuration
FLASK_SECRET_KEY="changeme!"
FLASK_DEBUG=False

7
README.md
View file

@ -36,9 +36,12 @@ You will need to have Docker and Docker Compose installed.
Clone the repository, go to its root and run `docker-compose -f docker-compose.dev.yml up -d`. Clone the repository, go to its root and run `docker-compose -f docker-compose.dev.yml up -d`.
To use the backend directly, go to the page [http://localhost:8080/api/feed/](http://localhost:8080/api/feed/) and start adding parameters! To use the backend directly, go to the page [http://localhost:8080/api/feed/](http://localhost:8080/api/feed/) and start adding parameters!
### For production ### Using Docker, for production
You will also need Docker and Docker Compose.
Copy `.env.example` to `.env` and edit the latter. Tweak your reverse proxy (in my case, Traefik). Then, run `docker compose up -d`.
*To do*
## Examples ## Examples