✨ Migrate from pgAdmin to Adminer#692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 1 commit into from
Mar 12, 2024
Merged

✨ Migrate from pgAdmin to Adminer #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .env
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,6 @@ POSTGRES_DB=app
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changethis

# PgAdmin
PGADMIN_DEFAULT_EMAIL=admin@example.com
PGADMIN_DEFAULT_PASSWORD=changethis
PGADMIN_LISTEN_PORT=5050

SENTRY_DSN=

# Flower
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/deploy-production.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
steps:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/deploy-staging.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
steps:
Expand Down
2 changes: 0 additions & 2 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,8 +154,6 @@ The input variables, with their default values (some auto generated) are:
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"info@example.com"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `pgadmin_default_user`: (default: `"admin"`) The default user for pgAdmin, you can set it later in .env.
- `pgadmin_default_password`: (default: `"changethis"`) The default user password for pgAdmin, stored in .env.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
- `flower_basic_auth`: (default: `"admin:changethis"`) The basic auth for Flower, you can set it later in .env.

Expand Down
2 changes: 1 addition & 1 deletion backend/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ Backend, JSON based web API based on OpenAPI: http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs

PGAdmin, PostgreSQL web administration: http://localhost:5050
Adminer, database web administration: http://localhost:8080

Flower, administration of Celery tasks: http://localhost:5555

Expand Down
10 changes: 0 additions & 10 deletions copier.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,16 +54,6 @@ postgres_password:
python -c "import secrets; print(secrets.token_urlsafe(32))"'
default: changethis

pgadmin_default_email:
type: str
help: The default user email for pgAdmin, you can set it later in .env
default: admin@example.com

pgadmin_default_password:
type: str
help: The default user password for pgAdmin, stored in .env
default: changethis

sentry_dsn:
type: str
help: The DSN for Sentry, if you are using it, you can set it later in .env
Expand Down
10 changes: 3 additions & 7 deletions deployment.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓

* Have a remote server ready and available.
* Configure the DNS records of your domain to point to the IP of the server you just created.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `pgadmin.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.pgadmin.fastapi-project.example.com`, etc.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).

## Public Traefik
Expand DownExpand Up@@ -141,8 +141,6 @@ You can set several variables, like:
* `POSTGRES_PASSWORD`: The Postgres password.
* `POSTGRES_USER`: The Postgres user, you can leave the default.
* `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`.
* `PGADMIN_DEFAULT_EMAIL`: The default email for pgAdmin.
* `PGADMIN_DEFAULT_PASSWORD`: The default password for pgAdmin.
* `SENTRY_DSN`: The DSN for Sentry, if you are using it.
* `FLOWER_BASIC_AUTH`: The HTTP Basic Auth for Flower, like `admin:changethis`.

Expand DownExpand Up@@ -253,8 +251,6 @@ The current Github Actions workflows expect these secrets:
* `EMAILS_FROM_EMAIL`
* `FIRST_SUPERUSER`
* `FIRST_SUPERUSER_PASSWORD`
* `PGADMIN_DEFAULT_EMAIL`
* `PGADMIN_DEFAULT_PASSWORD`
* `POSTGRES_PASSWORD`
* `SECRET_KEY`

Expand DownExpand Up@@ -283,7 +279,7 @@ Backend API docs: `https://fastapi-project.example.com/docs`

Backend API base URL: `https://fastapi-project.example.com/api/`

PGAdmin: `https://pgadmin.fastapi-project.example.com`
Adminer: `https://adminer.fastapi-project.example.com`

Flower: `https://flower.fastapi-project.example.com`

Expand All@@ -295,6 +291,6 @@ Backend API docs: `https://staging.fastapi-project.example.com/docs`

Backend API base URL: `https://staging.fastapi-project.example.com/api/`

PGAdmin: `https://staging.pgadmin.fastapi-project.example.com`
Adminer: `https://staging.adminer.fastapi-project.example.com`

Flower: `https://staging.flower.fastapi-project.example.com`
4 changes: 2 additions & 2 deletions development.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost/docs

Automatic Alternative Docs (ReDoc): https://localhost/redoc

PGAdmin: http://localhost:5050
Adminer: http://localhost:8080

Flower: http://localhost:5555

Expand All@@ -125,7 +125,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc

PGAdmin: http://localhost.tiangolo.com:5050
Adminer: http://localhost.tiangolo.com:8080

Flower: http://localhost.tiangolo.com:5555

Expand Down
4 changes: 2 additions & 2 deletions docker-compose.override.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,10 @@ services:
ports:
- "5432:5432"

pgadmin:
adminer:
restart: "no"
ports:
- "5050:5050"
- "8080:8080"

queue:
restart: "no"
Expand Down
25 changes: 11 additions & 14 deletions docker-compose.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,31 +13,28 @@ services:
- POSTGRES_USER=${POSTGRES_USER?Variable not set}
- POSTGRES_DB=${POSTGRES_DB?Variable not set}

pgadmin:
image: dpage/pgadmin4
adminer:
image: adminer
restart: always
networks:
- traefik-public
- default
depends_on:
- db
env_file:
- .env
environment:
- PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
- PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
- ADMINER_DESIGN=pepa-linha-dark
labels:
- traefik.enable=true
- traefik.docker.network=traefik-public
- traefik.constraint-label=traefik-public
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=https-redirect
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
- traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050
- traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.entrypoints=http
- traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.middlewares=https-redirect
- traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.rule=Host(`adminer.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.entrypoints=https
- traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls=true
- traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls.certresolver=le
- traefik.http.services.${STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080

queue:
image: rabbitmq:3
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
✨ Migrate from pgAdmin to Adminer#692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Mar 12, 2024
 Merged


✨ Migrate from pgAdmin to Adminer
#692
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 0 additions & 5 deletions
.env

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,6 @@ POSTGRES_DB=app
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changethis

# PgAdmin
PGADMIN_DEFAULT_EMAIL=admin@example.com
PGADMIN_DEFAULT_PASSWORD=changethis
PGADMIN_LISTEN_PORT=5050

SENTRY_DSN=

# Flower
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-production.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-staging.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,8 +154,6 @@ The input variables, with their default values (some auto generated) are:
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"info@example.com"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `pgadmin_default_user`: (default: `"admin"`) The default user for pgAdmin, you can set it later in .env.
- `pgadmin_default_password`: (default: `"changethis"`) The default user password for pgAdmin, stored in .env.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
- `flower_basic_auth`: (default: `"admin:changethis"`) The basic auth for Flower, you can set it later in .env.

Expand Down

2 changes: 1 addition & 1 deletion
backend/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ Backend, JSON based web API based on OpenAPI: http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs

PGAdmin, PostgreSQL web administration: http://localhost:5050
Adminer, database web administration: http://localhost:8080

Flower, administration of Celery tasks: http://localhost:5555

Expand Down

10 changes: 0 additions & 10 deletions
copier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,16 +54,6 @@ postgres_password:
 python -c "import secrets; print(secrets.token_urlsafe(32))"'
 default: changethis

pgadmin_default_email:
 type: str
 help: The default user email for pgAdmin, you can set it later in .env
 default: admin@example.com

pgadmin_default_password:
 type: str
 help: The default user password for pgAdmin, stored in .env
 default: changethis

sentry_dsn:
 type: str
 help: The DSN for Sentry, if you are using it, you can set it later in .env
Expand Down

10 changes: 3 additions & 7 deletions
deployment.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓

* Have a remote server ready and available.
* Configure the DNS records of your domain to point to the IP of the server you just created.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `pgadmin.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.pgadmin.fastapi-project.example.com`, etc.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).

## Public Traefik
Expand DownExpand Up@@ -141,8 +141,6 @@ You can set several variables, like:
* `POSTGRES_PASSWORD`: The Postgres password.
* `POSTGRES_USER`: The Postgres user, you can leave the default.
* `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`.
* `PGADMIN_DEFAULT_EMAIL`: The default email for pgAdmin.
* `PGADMIN_DEFAULT_PASSWORD`: The default password for pgAdmin.
* `SENTRY_DSN`: The DSN for Sentry, if you are using it.
* `FLOWER_BASIC_AUTH`: The HTTP Basic Auth for Flower, like `admin:changethis`.

Expand DownExpand Up@@ -253,8 +251,6 @@ The current Github Actions workflows expect these secrets:
* `EMAILS_FROM_EMAIL`
* `FIRST_SUPERUSER`
* `FIRST_SUPERUSER_PASSWORD`
* `PGADMIN_DEFAULT_EMAIL`
* `PGADMIN_DEFAULT_PASSWORD`
* `POSTGRES_PASSWORD`
* `SECRET_KEY`

Expand DownExpand Up@@ -283,7 +279,7 @@ Backend API docs: `https://fastapi-project.example.com/docs`

Backend API base URL: `https://fastapi-project.example.com/api/`

PGAdmin: `https://pgadmin.fastapi-project.example.com`
Adminer: `https://adminer.fastapi-project.example.com`

Flower: `https://flower.fastapi-project.example.com`

Expand All@@ -295,6 +291,6 @@ Backend API docs: `https://staging.fastapi-project.example.com/docs`

Backend API base URL: `https://staging.fastapi-project.example.com/api/`

PGAdmin: `https://staging.pgadmin.fastapi-project.example.com`
Adminer: `https://staging.adminer.fastapi-project.example.com`

Flower: `https://staging.flower.fastapi-project.example.com`

4 changes: 2 additions & 2 deletions
development.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost/docs

Automatic Alternative Docs (ReDoc): https://localhost/redoc

PGAdmin: http://localhost:5050
Adminer: http://localhost:8080

Flower: http://localhost:5555

Expand All@@ -125,7 +125,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc

PGAdmin: http://localhost.tiangolo.com:5050
Adminer: http://localhost.tiangolo.com:8080

Flower: http://localhost.tiangolo.com:5555

Expand Down

4 changes: 2 additions & 2 deletions
docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,10 @@ services:
 ports:
 - "5432:5432"

pgadmin:
adminer:
 restart: "no"
 ports:
 - "5050:5050"
 - "8080:8080"

 queue:
 restart: "no"
Expand Down

25 changes: 11 additions & 14 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,31 +13,28 @@ services:
 - POSTGRES_USER=${POSTGRES_USER?Variable not set}
 - POSTGRES_DB=${POSTGRES_DB?Variable not set}

pgadmin:
 image: dpage/pgadmin4
adminer:
 image: adminer
 restart: always
 networks:
 - traefik-public
 - default
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
 - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
 - ADMINER_DESIGN=pepa-linha-dark
 labels:
 - traefik.enable=true
 - traefik.docker.network=traefik-public
 - traefik.constraint-label=traefik-public
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080

 queue:
 image: rabbitmq:3
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
✨ Migrate from pgAdmin to Adminer#692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Mar 12, 2024
 Merged


✨ Migrate from pgAdmin to Adminer
#692
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 0 additions & 5 deletions
.env

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,6 @@ POSTGRES_DB=app
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changethis

# PgAdmin
PGADMIN_DEFAULT_EMAIL=admin@example.com
PGADMIN_DEFAULT_PASSWORD=changethis
PGADMIN_LISTEN_PORT=5050

SENTRY_DSN=

# Flower
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-production.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-staging.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,8 +154,6 @@ The input variables, with their default values (some auto generated) are:
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"info@example.com"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `pgadmin_default_user`: (default: `"admin"`) The default user for pgAdmin, you can set it later in .env.
- `pgadmin_default_password`: (default: `"changethis"`) The default user password for pgAdmin, stored in .env.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
- `flower_basic_auth`: (default: `"admin:changethis"`) The basic auth for Flower, you can set it later in .env.

Expand Down

2 changes: 1 addition & 1 deletion
backend/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ Backend, JSON based web API based on OpenAPI: http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs

PGAdmin, PostgreSQL web administration: http://localhost:5050
Adminer, database web administration: http://localhost:8080

Flower, administration of Celery tasks: http://localhost:5555

Expand Down

10 changes: 0 additions & 10 deletions
copier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,16 +54,6 @@ postgres_password:
 python -c "import secrets; print(secrets.token_urlsafe(32))"'
 default: changethis

pgadmin_default_email:
 type: str
 help: The default user email for pgAdmin, you can set it later in .env
 default: admin@example.com

pgadmin_default_password:
 type: str
 help: The default user password for pgAdmin, stored in .env
 default: changethis

sentry_dsn:
 type: str
 help: The DSN for Sentry, if you are using it, you can set it later in .env
Expand Down

10 changes: 3 additions & 7 deletions
deployment.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓

* Have a remote server ready and available.
* Configure the DNS records of your domain to point to the IP of the server you just created.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `pgadmin.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.pgadmin.fastapi-project.example.com`, etc.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).

## Public Traefik
Expand DownExpand Up@@ -141,8 +141,6 @@ You can set several variables, like:
* `POSTGRES_PASSWORD`: The Postgres password.
* `POSTGRES_USER`: The Postgres user, you can leave the default.
* `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`.
* `PGADMIN_DEFAULT_EMAIL`: The default email for pgAdmin.
* `PGADMIN_DEFAULT_PASSWORD`: The default password for pgAdmin.
* `SENTRY_DSN`: The DSN for Sentry, if you are using it.
* `FLOWER_BASIC_AUTH`: The HTTP Basic Auth for Flower, like `admin:changethis`.

Expand DownExpand Up@@ -253,8 +251,6 @@ The current Github Actions workflows expect these secrets:
* `EMAILS_FROM_EMAIL`
* `FIRST_SUPERUSER`
* `FIRST_SUPERUSER_PASSWORD`
* `PGADMIN_DEFAULT_EMAIL`
* `PGADMIN_DEFAULT_PASSWORD`
* `POSTGRES_PASSWORD`
* `SECRET_KEY`

Expand DownExpand Up@@ -283,7 +279,7 @@ Backend API docs: `https://fastapi-project.example.com/docs`

Backend API base URL: `https://fastapi-project.example.com/api/`

PGAdmin: `https://pgadmin.fastapi-project.example.com`
Adminer: `https://adminer.fastapi-project.example.com`

Flower: `https://flower.fastapi-project.example.com`

Expand All@@ -295,6 +291,6 @@ Backend API docs: `https://staging.fastapi-project.example.com/docs`

Backend API base URL: `https://staging.fastapi-project.example.com/api/`

PGAdmin: `https://staging.pgadmin.fastapi-project.example.com`
Adminer: `https://staging.adminer.fastapi-project.example.com`

Flower: `https://staging.flower.fastapi-project.example.com`

4 changes: 2 additions & 2 deletions
development.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost/docs

Automatic Alternative Docs (ReDoc): https://localhost/redoc

PGAdmin: http://localhost:5050
Adminer: http://localhost:8080

Flower: http://localhost:5555

Expand All@@ -125,7 +125,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc

PGAdmin: http://localhost.tiangolo.com:5050
Adminer: http://localhost.tiangolo.com:8080

Flower: http://localhost.tiangolo.com:5555

Expand Down

4 changes: 2 additions & 2 deletions
docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,10 @@ services:
 ports:
 - "5432:5432"

pgadmin:
adminer:
 restart: "no"
 ports:
 - "5050:5050"
 - "8080:8080"

 queue:
 restart: "no"
Expand Down

25 changes: 11 additions & 14 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,31 +13,28 @@ services:
 - POSTGRES_USER=${POSTGRES_USER?Variable not set}
 - POSTGRES_DB=${POSTGRES_DB?Variable not set}

pgadmin:
 image: dpage/pgadmin4
adminer:
 image: adminer
 restart: always
 networks:
 - traefik-public
 - default
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
 - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
 - ADMINER_DESIGN=pepa-linha-dark
 labels:
 - traefik.enable=true
 - traefik.docker.network=traefik-public
 - traefik.constraint-label=traefik-public
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080

 queue:
 image: rabbitmq:3
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
✨ Migrate from pgAdmin to Adminer#692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Mar 12, 2024
 Merged


✨ Migrate from pgAdmin to Adminer
#692
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 0 additions & 5 deletions
.env

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,6 @@ POSTGRES_DB=app
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changethis

# PgAdmin
PGADMIN_DEFAULT_EMAIL=admin@example.com
PGADMIN_DEFAULT_PASSWORD=changethis
PGADMIN_LISTEN_PORT=5050

SENTRY_DSN=

# Flower
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-production.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-staging.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,8 +154,6 @@ The input variables, with their default values (some auto generated) are:
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"info@example.com"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `pgadmin_default_user`: (default: `"admin"`) The default user for pgAdmin, you can set it later in .env.
- `pgadmin_default_password`: (default: `"changethis"`) The default user password for pgAdmin, stored in .env.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
- `flower_basic_auth`: (default: `"admin:changethis"`) The basic auth for Flower, you can set it later in .env.

Expand Down

2 changes: 1 addition & 1 deletion
backend/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ Backend, JSON based web API based on OpenAPI: http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs

PGAdmin, PostgreSQL web administration: http://localhost:5050
Adminer, database web administration: http://localhost:8080

Flower, administration of Celery tasks: http://localhost:5555

Expand Down

10 changes: 0 additions & 10 deletions
copier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,16 +54,6 @@ postgres_password:
 python -c "import secrets; print(secrets.token_urlsafe(32))"'
 default: changethis

pgadmin_default_email:
 type: str
 help: The default user email for pgAdmin, you can set it later in .env
 default: admin@example.com

pgadmin_default_password:
 type: str
 help: The default user password for pgAdmin, stored in .env
 default: changethis

sentry_dsn:
 type: str
 help: The DSN for Sentry, if you are using it, you can set it later in .env
Expand Down

10 changes: 3 additions & 7 deletions
deployment.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓

* Have a remote server ready and available.
* Configure the DNS records of your domain to point to the IP of the server you just created.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `pgadmin.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.pgadmin.fastapi-project.example.com`, etc.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).

## Public Traefik
Expand DownExpand Up@@ -141,8 +141,6 @@ You can set several variables, like:
* `POSTGRES_PASSWORD`: The Postgres password.
* `POSTGRES_USER`: The Postgres user, you can leave the default.
* `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`.
* `PGADMIN_DEFAULT_EMAIL`: The default email for pgAdmin.
* `PGADMIN_DEFAULT_PASSWORD`: The default password for pgAdmin.
* `SENTRY_DSN`: The DSN for Sentry, if you are using it.
* `FLOWER_BASIC_AUTH`: The HTTP Basic Auth for Flower, like `admin:changethis`.

Expand DownExpand Up@@ -253,8 +251,6 @@ The current Github Actions workflows expect these secrets:
* `EMAILS_FROM_EMAIL`
* `FIRST_SUPERUSER`
* `FIRST_SUPERUSER_PASSWORD`
* `PGADMIN_DEFAULT_EMAIL`
* `PGADMIN_DEFAULT_PASSWORD`
* `POSTGRES_PASSWORD`
* `SECRET_KEY`

Expand DownExpand Up@@ -283,7 +279,7 @@ Backend API docs: `https://fastapi-project.example.com/docs`

Backend API base URL: `https://fastapi-project.example.com/api/`

PGAdmin: `https://pgadmin.fastapi-project.example.com`
Adminer: `https://adminer.fastapi-project.example.com`

Flower: `https://flower.fastapi-project.example.com`

Expand All@@ -295,6 +291,6 @@ Backend API docs: `https://staging.fastapi-project.example.com/docs`

Backend API base URL: `https://staging.fastapi-project.example.com/api/`

PGAdmin: `https://staging.pgadmin.fastapi-project.example.com`
Adminer: `https://staging.adminer.fastapi-project.example.com`

Flower: `https://staging.flower.fastapi-project.example.com`

4 changes: 2 additions & 2 deletions
development.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost/docs

Automatic Alternative Docs (ReDoc): https://localhost/redoc

PGAdmin: http://localhost:5050
Adminer: http://localhost:8080

Flower: http://localhost:5555

Expand All@@ -125,7 +125,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc

PGAdmin: http://localhost.tiangolo.com:5050
Adminer: http://localhost.tiangolo.com:8080

Flower: http://localhost.tiangolo.com:5555

Expand Down

4 changes: 2 additions & 2 deletions
docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,10 @@ services:
 ports:
 - "5432:5432"

pgadmin:
adminer:
 restart: "no"
 ports:
 - "5050:5050"
 - "8080:8080"

 queue:
 restart: "no"
Expand Down

25 changes: 11 additions & 14 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,31 +13,28 @@ services:
 - POSTGRES_USER=${POSTGRES_USER?Variable not set}
 - POSTGRES_DB=${POSTGRES_DB?Variable not set}

pgadmin:
 image: dpage/pgadmin4
adminer:
 image: adminer
 restart: always
 networks:
 - traefik-public
 - default
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
 - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
 - ADMINER_DESIGN=pepa-linha-dark
 labels:
 - traefik.enable=true
 - traefik.docker.network=traefik-public
 - traefik.constraint-label=traefik-public
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080

 queue:
 image: rabbitmq:3
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
✨ Migrate from pgAdmin to Adminer#692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Mar 12, 2024
 Merged


✨ Migrate from pgAdmin to Adminer
#692
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 0 additions & 5 deletions
.env

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,6 @@ POSTGRES_DB=app
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changethis

# PgAdmin
PGADMIN_DEFAULT_EMAIL=admin@example.com
PGADMIN_DEFAULT_PASSWORD=changethis
PGADMIN_LISTEN_PORT=5050

SENTRY_DSN=

# Flower
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-production.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-staging.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,8 +154,6 @@ The input variables, with their default values (some auto generated) are:
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"info@example.com"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `pgadmin_default_user`: (default: `"admin"`) The default user for pgAdmin, you can set it later in .env.
- `pgadmin_default_password`: (default: `"changethis"`) The default user password for pgAdmin, stored in .env.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
- `flower_basic_auth`: (default: `"admin:changethis"`) The basic auth for Flower, you can set it later in .env.

Expand Down

2 changes: 1 addition & 1 deletion
backend/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ Backend, JSON based web API based on OpenAPI: http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs

PGAdmin, PostgreSQL web administration: http://localhost:5050
Adminer, database web administration: http://localhost:8080

Flower, administration of Celery tasks: http://localhost:5555

Expand Down

10 changes: 0 additions & 10 deletions
copier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,16 +54,6 @@ postgres_password:
 python -c "import secrets; print(secrets.token_urlsafe(32))"'
 default: changethis

pgadmin_default_email:
 type: str
 help: The default user email for pgAdmin, you can set it later in .env
 default: admin@example.com

pgadmin_default_password:
 type: str
 help: The default user password for pgAdmin, stored in .env
 default: changethis

sentry_dsn:
 type: str
 help: The DSN for Sentry, if you are using it, you can set it later in .env
Expand Down

10 changes: 3 additions & 7 deletions
deployment.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓

* Have a remote server ready and available.
* Configure the DNS records of your domain to point to the IP of the server you just created.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `pgadmin.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.pgadmin.fastapi-project.example.com`, etc.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).

## Public Traefik
Expand DownExpand Up@@ -141,8 +141,6 @@ You can set several variables, like:
* `POSTGRES_PASSWORD`: The Postgres password.
* `POSTGRES_USER`: The Postgres user, you can leave the default.
* `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`.
* `PGADMIN_DEFAULT_EMAIL`: The default email for pgAdmin.
* `PGADMIN_DEFAULT_PASSWORD`: The default password for pgAdmin.
* `SENTRY_DSN`: The DSN for Sentry, if you are using it.
* `FLOWER_BASIC_AUTH`: The HTTP Basic Auth for Flower, like `admin:changethis`.

Expand DownExpand Up@@ -253,8 +251,6 @@ The current Github Actions workflows expect these secrets:
* `EMAILS_FROM_EMAIL`
* `FIRST_SUPERUSER`
* `FIRST_SUPERUSER_PASSWORD`
* `PGADMIN_DEFAULT_EMAIL`
* `PGADMIN_DEFAULT_PASSWORD`
* `POSTGRES_PASSWORD`
* `SECRET_KEY`

Expand DownExpand Up@@ -283,7 +279,7 @@ Backend API docs: `https://fastapi-project.example.com/docs`

Backend API base URL: `https://fastapi-project.example.com/api/`

PGAdmin: `https://pgadmin.fastapi-project.example.com`
Adminer: `https://adminer.fastapi-project.example.com`

Flower: `https://flower.fastapi-project.example.com`

Expand All@@ -295,6 +291,6 @@ Backend API docs: `https://staging.fastapi-project.example.com/docs`

Backend API base URL: `https://staging.fastapi-project.example.com/api/`

PGAdmin: `https://staging.pgadmin.fastapi-project.example.com`
Adminer: `https://staging.adminer.fastapi-project.example.com`

Flower: `https://staging.flower.fastapi-project.example.com`

4 changes: 2 additions & 2 deletions
development.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost/docs

Automatic Alternative Docs (ReDoc): https://localhost/redoc

PGAdmin: http://localhost:5050
Adminer: http://localhost:8080

Flower: http://localhost:5555

Expand All@@ -125,7 +125,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc

PGAdmin: http://localhost.tiangolo.com:5050
Adminer: http://localhost.tiangolo.com:8080

Flower: http://localhost.tiangolo.com:5555

Expand Down

4 changes: 2 additions & 2 deletions
docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,10 @@ services:
 ports:
 - "5432:5432"

pgadmin:
adminer:
 restart: "no"
 ports:
 - "5050:5050"
 - "8080:8080"

 queue:
 restart: "no"
Expand Down

25 changes: 11 additions & 14 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,31 +13,28 @@ services:
 - POSTGRES_USER=${POSTGRES_USER?Variable not set}
 - POSTGRES_DB=${POSTGRES_DB?Variable not set}

pgadmin:
 image: dpage/pgadmin4
adminer:
 image: adminer
 restart: always
 networks:
 - traefik-public
 - default
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
 - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
 - ADMINER_DESIGN=pepa-linha-dark
 labels:
 - traefik.enable=true
 - traefik.docker.network=traefik-public
 - traefik.constraint-label=traefik-public
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080

 queue:
 image: rabbitmq:3
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
✨ Migrate from pgAdmin to Adminer#692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Mar 12, 2024
 Merged


✨ Migrate from pgAdmin to Adminer
#692
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 0 additions & 5 deletions
.env

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,6 @@ POSTGRES_DB=app
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changethis

# PgAdmin
PGADMIN_DEFAULT_EMAIL=admin@example.com
PGADMIN_DEFAULT_PASSWORD=changethis
PGADMIN_LISTEN_PORT=5050

SENTRY_DSN=

# Flower
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-production.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-staging.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,8 +154,6 @@ The input variables, with their default values (some auto generated) are:
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"info@example.com"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `pgadmin_default_user`: (default: `"admin"`) The default user for pgAdmin, you can set it later in .env.
- `pgadmin_default_password`: (default: `"changethis"`) The default user password for pgAdmin, stored in .env.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
- `flower_basic_auth`: (default: `"admin:changethis"`) The basic auth for Flower, you can set it later in .env.

Expand Down

2 changes: 1 addition & 1 deletion
backend/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ Backend, JSON based web API based on OpenAPI: http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs

PGAdmin, PostgreSQL web administration: http://localhost:5050
Adminer, database web administration: http://localhost:8080

Flower, administration of Celery tasks: http://localhost:5555

Expand Down

10 changes: 0 additions & 10 deletions
copier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,16 +54,6 @@ postgres_password:
 python -c "import secrets; print(secrets.token_urlsafe(32))"'
 default: changethis

pgadmin_default_email:
 type: str
 help: The default user email for pgAdmin, you can set it later in .env
 default: admin@example.com

pgadmin_default_password:
 type: str
 help: The default user password for pgAdmin, stored in .env
 default: changethis

sentry_dsn:
 type: str
 help: The DSN for Sentry, if you are using it, you can set it later in .env
Expand Down

10 changes: 3 additions & 7 deletions
deployment.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓

* Have a remote server ready and available.
* Configure the DNS records of your domain to point to the IP of the server you just created.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `pgadmin.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.pgadmin.fastapi-project.example.com`, etc.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).

## Public Traefik
Expand DownExpand Up@@ -141,8 +141,6 @@ You can set several variables, like:
* `POSTGRES_PASSWORD`: The Postgres password.
* `POSTGRES_USER`: The Postgres user, you can leave the default.
* `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`.
* `PGADMIN_DEFAULT_EMAIL`: The default email for pgAdmin.
* `PGADMIN_DEFAULT_PASSWORD`: The default password for pgAdmin.
* `SENTRY_DSN`: The DSN for Sentry, if you are using it.
* `FLOWER_BASIC_AUTH`: The HTTP Basic Auth for Flower, like `admin:changethis`.

Expand DownExpand Up@@ -253,8 +251,6 @@ The current Github Actions workflows expect these secrets:
* `EMAILS_FROM_EMAIL`
* `FIRST_SUPERUSER`
* `FIRST_SUPERUSER_PASSWORD`
* `PGADMIN_DEFAULT_EMAIL`
* `PGADMIN_DEFAULT_PASSWORD`
* `POSTGRES_PASSWORD`
* `SECRET_KEY`

Expand DownExpand Up@@ -283,7 +279,7 @@ Backend API docs: `https://fastapi-project.example.com/docs`

Backend API base URL: `https://fastapi-project.example.com/api/`

PGAdmin: `https://pgadmin.fastapi-project.example.com`
Adminer: `https://adminer.fastapi-project.example.com`

Flower: `https://flower.fastapi-project.example.com`

Expand All@@ -295,6 +291,6 @@ Backend API docs: `https://staging.fastapi-project.example.com/docs`

Backend API base URL: `https://staging.fastapi-project.example.com/api/`

PGAdmin: `https://staging.pgadmin.fastapi-project.example.com`
Adminer: `https://staging.adminer.fastapi-project.example.com`

Flower: `https://staging.flower.fastapi-project.example.com`

4 changes: 2 additions & 2 deletions
development.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost/docs

Automatic Alternative Docs (ReDoc): https://localhost/redoc

PGAdmin: http://localhost:5050
Adminer: http://localhost:8080

Flower: http://localhost:5555

Expand All@@ -125,7 +125,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc

PGAdmin: http://localhost.tiangolo.com:5050
Adminer: http://localhost.tiangolo.com:8080

Flower: http://localhost.tiangolo.com:5555

Expand Down

4 changes: 2 additions & 2 deletions
docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,10 @@ services:
 ports:
 - "5432:5432"

pgadmin:
adminer:
 restart: "no"
 ports:
 - "5050:5050"
 - "8080:8080"

 queue:
 restart: "no"
Expand Down

25 changes: 11 additions & 14 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,31 +13,28 @@ services:
 - POSTGRES_USER=${POSTGRES_USER?Variable not set}
 - POSTGRES_DB=${POSTGRES_DB?Variable not set}

pgadmin:
 image: dpage/pgadmin4
adminer:
 image: adminer
 restart: always
 networks:
 - traefik-public
 - default
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
 - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
 - ADMINER_DESIGN=pepa-linha-dark
 labels:
 - traefik.enable=true
 - traefik.docker.network=traefik-public
 - traefik.constraint-label=traefik-public
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080

 queue:
 image: rabbitmq:3
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
✨ Migrate from pgAdmin to Adminer#692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Mar 12, 2024
 Merged


✨ Migrate from pgAdmin to Adminer
#692
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 0 additions & 5 deletions
.env

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,6 @@ POSTGRES_DB=app
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changethis

# PgAdmin
PGADMIN_DEFAULT_EMAIL=admin@example.com
PGADMIN_DEFAULT_PASSWORD=changethis
PGADMIN_LISTEN_PORT=5050

SENTRY_DSN=

# Flower
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-production.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-staging.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,8 +154,6 @@ The input variables, with their default values (some auto generated) are:
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"info@example.com"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `pgadmin_default_user`: (default: `"admin"`) The default user for pgAdmin, you can set it later in .env.
- `pgadmin_default_password`: (default: `"changethis"`) The default user password for pgAdmin, stored in .env.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
- `flower_basic_auth`: (default: `"admin:changethis"`) The basic auth for Flower, you can set it later in .env.

Expand Down

2 changes: 1 addition & 1 deletion
backend/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ Backend, JSON based web API based on OpenAPI: http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs

PGAdmin, PostgreSQL web administration: http://localhost:5050
Adminer, database web administration: http://localhost:8080

Flower, administration of Celery tasks: http://localhost:5555

Expand Down

10 changes: 0 additions & 10 deletions
copier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,16 +54,6 @@ postgres_password:
 python -c "import secrets; print(secrets.token_urlsafe(32))"'
 default: changethis

pgadmin_default_email:
 type: str
 help: The default user email for pgAdmin, you can set it later in .env
 default: admin@example.com

pgadmin_default_password:
 type: str
 help: The default user password for pgAdmin, stored in .env
 default: changethis

sentry_dsn:
 type: str
 help: The DSN for Sentry, if you are using it, you can set it later in .env
Expand Down

10 changes: 3 additions & 7 deletions
deployment.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓

* Have a remote server ready and available.
* Configure the DNS records of your domain to point to the IP of the server you just created.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `pgadmin.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.pgadmin.fastapi-project.example.com`, etc.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).

## Public Traefik
Expand DownExpand Up@@ -141,8 +141,6 @@ You can set several variables, like:
* `POSTGRES_PASSWORD`: The Postgres password.
* `POSTGRES_USER`: The Postgres user, you can leave the default.
* `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`.
* `PGADMIN_DEFAULT_EMAIL`: The default email for pgAdmin.
* `PGADMIN_DEFAULT_PASSWORD`: The default password for pgAdmin.
* `SENTRY_DSN`: The DSN for Sentry, if you are using it.
* `FLOWER_BASIC_AUTH`: The HTTP Basic Auth for Flower, like `admin:changethis`.

Expand DownExpand Up@@ -253,8 +251,6 @@ The current Github Actions workflows expect these secrets:
* `EMAILS_FROM_EMAIL`
* `FIRST_SUPERUSER`
* `FIRST_SUPERUSER_PASSWORD`
* `PGADMIN_DEFAULT_EMAIL`
* `PGADMIN_DEFAULT_PASSWORD`
* `POSTGRES_PASSWORD`
* `SECRET_KEY`

Expand DownExpand Up@@ -283,7 +279,7 @@ Backend API docs: `https://fastapi-project.example.com/docs`

Backend API base URL: `https://fastapi-project.example.com/api/`

PGAdmin: `https://pgadmin.fastapi-project.example.com`
Adminer: `https://adminer.fastapi-project.example.com`

Flower: `https://flower.fastapi-project.example.com`

Expand All@@ -295,6 +291,6 @@ Backend API docs: `https://staging.fastapi-project.example.com/docs`

Backend API base URL: `https://staging.fastapi-project.example.com/api/`

PGAdmin: `https://staging.pgadmin.fastapi-project.example.com`
Adminer: `https://staging.adminer.fastapi-project.example.com`

Flower: `https://staging.flower.fastapi-project.example.com`

4 changes: 2 additions & 2 deletions
development.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost/docs

Automatic Alternative Docs (ReDoc): https://localhost/redoc

PGAdmin: http://localhost:5050
Adminer: http://localhost:8080

Flower: http://localhost:5555

Expand All@@ -125,7 +125,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc

PGAdmin: http://localhost.tiangolo.com:5050
Adminer: http://localhost.tiangolo.com:8080

Flower: http://localhost.tiangolo.com:5555

Expand Down

4 changes: 2 additions & 2 deletions
docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,10 @@ services:
 ports:
 - "5432:5432"

pgadmin:
adminer:
 restart: "no"
 ports:
 - "5050:5050"
 - "8080:8080"

 queue:
 restart: "no"
Expand Down

25 changes: 11 additions & 14 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,31 +13,28 @@ services:
 - POSTGRES_USER=${POSTGRES_USER?Variable not set}
 - POSTGRES_DB=${POSTGRES_DB?Variable not set}

pgadmin:
 image: dpage/pgadmin4
adminer:
 image: adminer
 restart: always
 networks:
 - traefik-public
 - default
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
 - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
 - ADMINER_DESIGN=pepa-linha-dark
 labels:
 - traefik.enable=true
 - traefik.docker.network=traefik-public
 - traefik.constraint-label=traefik-public
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080

 queue:
 image: rabbitmq:3
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
✨ Migrate from pgAdmin to Adminer#692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Mar 12, 2024
 Merged


✨ Migrate from pgAdmin to Adminer
#692
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 0 additions & 5 deletions
.env

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,6 @@ POSTGRES_DB=app
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changethis

# PgAdmin
PGADMIN_DEFAULT_EMAIL=admin@example.com
PGADMIN_DEFAULT_PASSWORD=changethis
PGADMIN_LISTEN_PORT=5050

SENTRY_DSN=

# Flower
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-production.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
.github/workflows/deploy-staging.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,6 @@ jobs:
 SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
 EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
 POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
 PGADMIN_DEFAULT_EMAIL: ${{ secrets.PGADMIN_DEFAULT_EMAIL }}
 PGADMIN_DEFAULT_PASSWORD: ${{ secrets.PGADMIN_DEFAULT_PASSWORD }}
 SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 FLOWER_BASIC_AUTH: ${{ secrets.FLOWER_BASIC_AUTH }}
 steps:
Expand Down

2 changes: 0 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,8 +154,6 @@ The input variables, with their default values (some auto generated) are:
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"info@example.com"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `pgadmin_default_user`: (default: `"admin"`) The default user for pgAdmin, you can set it later in .env.
- `pgadmin_default_password`: (default: `"changethis"`) The default user password for pgAdmin, stored in .env.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
- `flower_basic_auth`: (default: `"admin:changethis"`) The basic auth for Flower, you can set it later in .env.

Expand Down

2 changes: 1 addition & 1 deletion
backend/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ Backend, JSON based web API based on OpenAPI: http://localhost/api/

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://localhost/docs

PGAdmin, PostgreSQL web administration: http://localhost:5050
Adminer, database web administration: http://localhost:8080

Flower, administration of Celery tasks: http://localhost:5555

Expand Down

10 changes: 0 additions & 10 deletions
copier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,16 +54,6 @@ postgres_password:
 python -c "import secrets; print(secrets.token_urlsafe(32))"'
 default: changethis

pgadmin_default_email:
 type: str
 help: The default user email for pgAdmin, you can set it later in .env
 default: admin@example.com

pgadmin_default_password:
 type: str
 help: The default user password for pgAdmin, stored in .env
 default: changethis

sentry_dsn:
 type: str
 help: The DSN for Sentry, if you are using it, you can set it later in .env
Expand Down

10 changes: 3 additions & 7 deletions
deployment.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ But you have to configure a couple things first. 🤓

* Have a remote server ready and available.
* Configure the DNS records of your domain to point to the IP of the server you just created.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `pgadmin.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.pgadmin.fastapi-project.example.com`, etc.
* Configure a wildcard subdomain for your domain, so that you can have multiple subdomains for different services, e.g. `*.fastapi-project.example.com`. This will be useful for accessing different components, like `traefik.fastapi-project.example.com`, `adminer.fastapi-project.example.com`, etc. And also for `staging`, like `staging.fastapi-project.example.com`, `staging.adminer.fastapi-project.example.com`, etc.
* Install and configure [Docker](https://docs.docker.com/engine/install/) on the remote server (Docker Engine, not Docker Desktop).

## Public Traefik
Expand DownExpand Up@@ -141,8 +141,6 @@ You can set several variables, like:
* `POSTGRES_PASSWORD`: The Postgres password.
* `POSTGRES_USER`: The Postgres user, you can leave the default.
* `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`.
* `PGADMIN_DEFAULT_EMAIL`: The default email for pgAdmin.
* `PGADMIN_DEFAULT_PASSWORD`: The default password for pgAdmin.
* `SENTRY_DSN`: The DSN for Sentry, if you are using it.
* `FLOWER_BASIC_AUTH`: The HTTP Basic Auth for Flower, like `admin:changethis`.

Expand DownExpand Up@@ -253,8 +251,6 @@ The current Github Actions workflows expect these secrets:
* `EMAILS_FROM_EMAIL`
* `FIRST_SUPERUSER`
* `FIRST_SUPERUSER_PASSWORD`
* `PGADMIN_DEFAULT_EMAIL`
* `PGADMIN_DEFAULT_PASSWORD`
* `POSTGRES_PASSWORD`
* `SECRET_KEY`

Expand DownExpand Up@@ -283,7 +279,7 @@ Backend API docs: `https://fastapi-project.example.com/docs`

Backend API base URL: `https://fastapi-project.example.com/api/`

PGAdmin: `https://pgadmin.fastapi-project.example.com`
Adminer: `https://adminer.fastapi-project.example.com`

Flower: `https://flower.fastapi-project.example.com`

Expand All@@ -295,6 +291,6 @@ Backend API docs: `https://staging.fastapi-project.example.com/docs`

Backend API base URL: `https://staging.fastapi-project.example.com/api/`

PGAdmin: `https://staging.pgadmin.fastapi-project.example.com`
Adminer: `https://staging.adminer.fastapi-project.example.com`

Flower: `https://staging.flower.fastapi-project.example.com`

4 changes: 2 additions & 2 deletions
development.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost/docs

Automatic Alternative Docs (ReDoc): https://localhost/redoc

PGAdmin: http://localhost:5050
Adminer: http://localhost:8080

Flower: http://localhost:5555

Expand All@@ -125,7 +125,7 @@ Automatic Interactive Docs (Swagger UI): https://localhost.tiangolo.com/docs

Automatic Alternative Docs (ReDoc): https://localhost.tiangolo.com/redoc

PGAdmin: http://localhost.tiangolo.com:5050
Adminer: http://localhost.tiangolo.com:8080

Flower: http://localhost.tiangolo.com:5555

Expand Down

4 changes: 2 additions & 2 deletions
docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,10 @@ services:
 ports:
 - "5432:5432"

pgadmin:
adminer:
 restart: "no"
 ports:
 - "5050:5050"
 - "8080:8080"

 queue:
 restart: "no"
Expand Down

25 changes: 11 additions & 14 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,31 +13,28 @@ services:
 - POSTGRES_USER=${POSTGRES_USER?Variable not set}
 - POSTGRES_DB=${POSTGRES_DB?Variable not set}

pgadmin:
 image: dpage/pgadmin4
adminer:
 image: adminer
 restart: always
 networks:
 - traefik-public
 - default
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
 - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
 - ADMINER_DESIGN=pepa-linha-dark
 labels:
 - traefik.enable=true
 - traefik.docker.network=traefik-public
 - traefik.constraint-label=traefik-public
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-http.middlewares=https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.rule=Host(`adminer.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-adminer-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080

 queue:
 image: rabbitmq:3
Expand Down