📝 Refactor README into separate README.md files for backend, frontend, deployment, development (#639)

This commit is contained in:
Sebastián Ramírez
2024-03-07 20:49:43 +01:00
committed by GitHub
parent 7a82434ab5
commit 4c1f75ce72
6 changed files with 418 additions and 423 deletions

25
deployment.md Normal file
View File

@@ -0,0 +1,25 @@
# FastAPI Project - Deployment
You can deploy the using Docker Compose with a main Traefik proxy outside handling communication to the outside world and HTTPS certificates.
And you can use CI (continuous integration) systems to do it automatically.
But you have to configure a couple things first.
## Traefik network
This stack expects the public Traefik network to be named `traefik-public`.
If you need to use a different Traefik public network name, update it in the `docker-compose.yml` files, in the section:
```YAML
networks:
traefik-public:
external: true
```
Change `traefik-public` to the name of the used Traefik network. And then update it in the file `.env`:
```bash
TRAEFIK_PUBLIC_NETWORK=traefik-public
```