Skip to content

Commit 14a5667

Browse files
committed
📝 Remove obsolete local domain setup
1 parent b1abd91 commit 14a5667

2 files changed

Lines changed: 1 addition & 51 deletions

File tree

compose.override.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
services:
22

3-
# Local services are available on their ports, but also available on:
4-
# http://localhost.tiangolo.com: application
5-
# etc. To enable it, update .env, set:
6-
# DOMAIN=localhost.tiangolo.com
73
proxy:
84
image: traefik:3.6
95
ports:

development.md

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -75,40 +75,12 @@ Mailcatcher: <http://localhost:1080>
7575

7676
Stop a locally running FastAPI server before starting the Compose backend because both use port `8000`.
7777

78-
**Note**: The first time you start the stack, it might take a minute to be ready while the backend waits for the database and configures everything. To monitor it, use `docker compose logs`, or `docker compose logs backend` for the backend service.
78+
**Note**: The first time you start the stack, it might take a minute for all the services to be ready. To monitor it, use `docker compose logs`, or `docker compose logs backend` for the backend service.
7979

8080
## Mailcatcher
8181

8282
Mailcatcher captures emails sent during local development instead of delivering them. The local backend connects to it at `localhost:1025`, and the Compose backend connects to the `mailcatcher` service. Captured emails are available at <http://localhost:1080>.
8383

84-
## Docker Compose in `localhost.tiangolo.com`
85-
86-
When you start the Docker Compose stack, it uses `localhost` by default, with different ports for each service (backend, adminer, etc).
87-
88-
When you deploy it to production (or staging), the application uses one domain. The frontend is served at `/` and the API lives under `/api`.
89-
90-
In the guide about [deployment](deployment.md) you can read about Traefik, the configured proxy. That's the component in charge of transmitting traffic to the application service based on the domain.
91-
92-
If you want to test that it's all working locally, you can edit the local `.env` file, and change:
93-
94-
```dotenv
95-
DOMAIN=localhost.tiangolo.com
96-
```
97-
98-
That will be used by the Docker Compose files to configure the base domain for the services.
99-
100-
Traefik will transmit application traffic at `localhost.tiangolo.com` to FastAPI, which serves both the frontend and API.
101-
102-
The domain `localhost.tiangolo.com` is a special domain that is configured (with all its subdomains) to point to `127.0.0.1`. This way you can use that for your local development.
103-
104-
After you update it, run again:
105-
106-
```bash
107-
docker compose watch
108-
```
109-
110-
Traefik is included in the main Docker Compose file. The development overrides expose its local dashboard so you can inspect the routes used with `localhost.tiangolo.com`.
111-
11284
## Docker Compose files and env vars
11385

11486
There is a main `compose.yml` file with all the configurations that apply to the whole stack, it is used automatically by `docker compose`.
@@ -119,8 +91,6 @@ The `compose.deploy.yml` file contains the deployment-specific settings, includi
11991

12092
The backend reads local settings from the `.env` file. Docker Compose also uses it for variable interpolation and passes the settings each container needs.
12193

122-
They also use some additional configurations taken from environment variables set in the scripts before calling the `docker compose` command.
123-
12494
After changing variables, make sure you restart the stack:
12595

12696
```bash
@@ -203,19 +173,3 @@ Adminer: <http://localhost:8080>
203173
Traefik UI: <http://localhost:8090>
204174

205175
MailCatcher: <http://localhost:1080>
206-
207-
### Development URLs with `localhost.tiangolo.com` Configured
208-
209-
Development URLs, for local development.
210-
211-
Application: <http://localhost.tiangolo.com>
212-
213-
Automatic Interactive Docs (Swagger UI): <http://localhost.tiangolo.com/docs>
214-
215-
Automatic Alternative Docs (ReDoc): <http://localhost.tiangolo.com/redoc>
216-
217-
Adminer: <http://localhost.tiangolo.com:8080>
218-
219-
Traefik UI: <http://localhost.tiangolo.com:8090>
220-
221-
MailCatcher: <http://localhost.tiangolo.com:1080>

0 commit comments

Comments
 (0)