mirror of https://github.com/status-im/status-python-sdk.git synced 2026-08-30 21:51:14 +00:00

Files

T

Nick Ninov d7e5f65d6f create_account: Dockerfile

- Create Status App account only with Dockerfile
- Add different docker-compose running profile
- Update documentation
- Config `bot_name` is optional. You can specify the bot name in `.env`

2026-03-05 18:06:39 +00:00

2.7 KiB

Raw Blame History

Status App Monitoring

Monitoring tool for Status App communities

Setup

Environment Variables

POSTGRES_USERNAME - Postgres username.
POSTGRES_DATABASE - The database name in the Postgres connection.
POSTGRES_HOST - The Postgres host name that will be remotely connected to.
POSTGRES_PORT - The Postgres port that will be remotely connected to.
STATUS_BACKEND_BASE_URL (OPTIONAL) - The Status Backend URL. If you are running locally you do not need this variable (localhost will be automatically set). If you are running it in a Docker container, please set it to status-backend (as the container_name of the docker-compose.yaml).
STATUS_USERNAME - The Status username that will be used to create an account. This is required if you are running Dockerfile for create_account.py.
STATUS_PASSWORD - The Status password that will be used to create an account. This is required if you are running Dockerfile for create_account.py.

Docker

docker login harbor.status.im

Account Creation

To create an account, please make sure you have set the following environment variables:

STATUS_BACKEND_BASE_URL
STATUS_USERNAME
STATUS_PASSWORD

docker compose --profile account-creation up

Monitoring

To download and upload messages, please make sure you have set the following environment variables:

POSTGRES_USERNAME
POSTGRES_DATABASE
POSTGRES_HOST
POSTGRES_PORT
STATUS_BACKEND_BASE_URL

docker compose --profile monitoring up

Status Backend

Run Backend independently so you can develop and test locally.

docker compose --profile backend up

Python

Setup environment. Conda example:

conda create -n status-monitoring python=3.12

Note: Code has been tested with Python 3.12.

Install requirements

pip install -r requirements.txt

Note: If you are on Windows, you will have to install psycopg2 instead of psycopg2-binary.

Files

Short explanation of what each runnable file does:

create_account.py - create a Status App account for the given username and password. Example runs:
- python create_account.py -u snt-maxxer -p StatusApp#123
- python create_account.py --username snt-maxxer --password StatusApp#123
- python create_account.py works if you have added STATUS_USERNAME and STATUS_PASSWORD in your .env file.
download.py - download all messages and overall community info from the specified Status App channels in config.yaml.
upload.py - upload data from download.py to Postgres.

2.7 KiB Raw Blame History