Host pgAdmin 4 for Your PostgreSQL Database

​

Introduction

• This article guides you through creating and hosting a pgAdmin application on Square Cloud.
• Before getting started, make sure you have an account on Square Cloud, which you can create on the signup page with your email.
• Finally, you need to have an active plan on your account. Compare the available plans and choose one according to your needs.

​

Creating the Project

• pgAdmin runs on Python, so the project needs a requirements.txt or a pyproject.toml. See how to create a requirements.txt.
• Your requirements.txt must have pgadmin4 and a web server to serve it. In this tutorial, we will use gunicorn.

pgadmin4
gunicorn

• Next, you will need a config file config_local.py to set some paths. These paths will define where to save some infos about your pgadmin.

SERVER_MODE = True
MAX_LOGIN_ATTEMPTS = 3
"""
    CRITICAL 50
    ERROR    40
    WARNING  30
    SQL      25
    INFO     20
    DEBUG    10
    NOTSET    0
"""
CONSOLE_LOG_LEVEL = 10
DATA_DIR = "/application/.pgadmin/"
LOG_FILE = "/application/.pgadmin/logfile"
SQLITE_PATH = '/application/.pgadmin/pgadmin4.db'

​

Files in your ZIP

• requirements.txt or pyproject.toml
• config_local.py
• squarecloud.app (the configuration file below)

​

Configuration File

• When uploading from the dashboard, set the runtime manually to Python and use the START command below as the startup command. In a squarecloud.app configuration file, that looks like this:

DISPLAY_NAME=App name
RUNTIME=python
MEMORY=1024
START=python -m gunicorn --bind 0.0.0.0:80 --workers=1 --threads=4 pgadmin4.pgAdmin4:app
VERSION=recommended
SUBDOMAIN=my-pgadmin-subdomain

• Gunicorn listens on port 80 on all interfaces (0.0.0.0), where Square Cloud delivers your subdomain’s traffic. Keep a single worker (--workers=1) and add threads instead: with more workers, pgAdmin fails with CSRF errors.
• Next, set 2 environment variables, PGADMIN_SETUP_EMAIL and PGADMIN_SETUP_PASSWORD. pgAdmin uses them to create the first user when it starts for the first time.

PGADMIN_SETUP_EMAIL=accessemail@example.com
PGADMIN_SETUP_PASSWORD=yourSecurePassword

• Set them in the upload form’s Advanced configuration, on the application’s Environment Variables page (then restart it), or with squarecloud app env set. pgAdmin doesn’t read a .env file at the root of your project, so a file like the one above only works as .squarecloud/.env, the file Square Cloud loads when the application starts (our ready-made release uses it). See Environment variables.

​

Uploading the Project to Square Cloud

​

Via dashboard

1

Access the Upload Page

Access the upload page and upload your project zip file.

2

Configure Your Environment

After uploading your zip, you will need to configure the name, main file or runtime environment and other settings for your project.
If you are uploading a web project, make sure to select “Web Publication” and set a subdomain to your project.

3

Deploy Your Project

Finally, click on the “Deploy” button to host your project on Square Cloud.
After deployment, you can monitor your project’s status and logs from the dashboard.

4

Confirm Your App Is Live

Your first deploy usually takes less than a minute. In the dashboard, wait for your application status to show as running and check the logs for any startup errors.
If you deployed a website or API, open https://<your-subdomain>.squareweb.app in your browser: you should see your application responding. If you deployed a bot, send it a command to confirm it is online.

App not starting? See the Troubleshooting guide for the most common causes and fixes.

​

Via CLI

curl -fsSL https://cli.squarecloud.app/install | bash

npm install -g @squarecloud/cli@latest

squarecloud auth login

squarecloud upload

squarecloud upload --file <path/to/zip>

squarecloud app status
squarecloud app logs

​

Final Considerations

​

Next steps

​

Contact us