How to deploy your PG Admin

​

Introduction

• This article guides you through creating and hosting a PG Admin application on Square Cloud.
• Before getting started, make sure you have an account on Square Cloud, which can be done through the sign up page. You can use your email to create an account.
• Finally, you need to have an active paid plan on your account. You can view our plans and purchase one according to your needs here.

​

Creating the Project

• First of all we need an Python environment. To do this, we need a requirements.txt or a pyproject.toml. You can see how to create a requirements.txt here.
• Your requirements.txt must have pgadmin4 and a webserver 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'

​

📁 Necessary Files

• requirements.txt or pyproject.toml
• .env (optional)

​

⚙️ Configuration File

• You need to configure runtime environment to Detect manually and set it to Python. In a squarecloud.config or squarecloud.app will look 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

• Next, we need to set 2 environment variables, PGADMIN_SETUP_EMAIL and PGADMIN_SETUP_PASSWORD in a .env file or in the Square Cloud environment on the upload menu.

PGADMIN_SETUP_EMAIL=accessemail@example.com
PGADMIN_SETUP_PASSWORD=yourSecurePassword

​

Uploading the Project to Square Cloud

• Upload via Dashboard
• Upload via CLI

Access the Square Cloud Dashboard and upload your project files.

1

First Step

First, you need to have the CLI installed in your environment. If you don’t have it yet, run the following command in your terminal:

npm install -g @squarecloud/cli

If you already have it, we recommend updating it. To do this, run the following command in your terminal:

• Windows
• Linux, macOS, and WSL

squarecloud update

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

2

Second Step

Now, to authenticate and use other CLI commands, you will find your authorization key here by clicking on “Request API Key”. After obtaining your authorization key, run the following command:

squarecloud auth login

3

Third Step

Finally, to deploy your application to Square Cloud using the CLI, you need to run the following command, passing the path to your zip file:

squarecloud upload zip

​

Final Considerations

​

Contact us