From 0f54e629b9f114c4e07a5ca4593ae7e3a46c6f0b Mon Sep 17 00:00:00 2001 From: Willard Nilges Date: Sun, 1 Mar 2026 18:24:10 -0500 Subject: [PATCH] update dev environment setup instructions --- HACKING/README.md | 21 +++++++++++---------- HACKING/launch_env.sh | 6 ------ HACKING/stop_env.sh | 6 ------ 3 files changed, 11 insertions(+), 22 deletions(-) delete mode 100755 HACKING/launch_env.sh delete mode 100755 HACKING/stop_env.sh diff --git a/HACKING/README.md b/HACKING/README.md index 48f77d1..48ea974 100644 --- a/HACKING/README.md +++ b/HACKING/README.md @@ -20,25 +20,26 @@ source venv/bin/activate ### Podman Environment Instructions -1. Build your containers. The `proxstar` container serves as proxstar, rq, rq-scheduler, and VNC. The `proxstar-postgres` container sets up the database schema. +1. Copy `.env.template` to `.env` and fill it out with the help of an RTP -`mkdir HACKING/proxstar-postgres/volume` - -`podman build . --tag=proxstar` +2. Create volume for postgres -`podman build HACKING/proxstar-postgres --tag=proxstar-postgres` +`mkdir HACKING/proxstar-postgres/volume` -2. Configure your environment variables. I'd recommend setting up a .env file and passing that into your container. Check `.env.template` for more info. +3. Build the proxstar container and launch it on your system. -3. Run it. This sets up redis, postgres, rq, and proxstar. +`podman compose up -d` -`./HACKING/launch_env.sh` +To access the proxstar WebUI, go to https://localhost:8000 4. To stop all containers, use the provided script -`./HACKING/stop_env.sh` +`podman compose down` + +## Setting up a full dev environment (Advanced) -## Setting up a full dev environment +> [!INFO] +> This is not required for most contributors If you want to work on Proxstar using a 1:1 development setup, there are a couple things you're going to need diff --git a/HACKING/launch_env.sh b/HACKING/launch_env.sh deleted file mode 100755 index e731503..0000000 --- a/HACKING/launch_env.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash -podman run --rm -d --network=proxstar --name=proxstar-redis redis:alpine -podman run --rm -d --network=proxstar --name=proxstar-postgres -e POSTGRES_PASSWORD=changeme -v ./HACKING/proxstar-postgres/volume:/var/lib/postgresql/data:Z proxstar-postgres -podman run --rm -d --network=proxstar --name=proxstar-rq-scheduler --env-file=HACKING/.env --entrypoint ./start_scheduler.sh proxstar -podman run --rm -d --network=proxstar --name=proxstar-rq --env-file=HACKING/.env --entrypoint ./start_worker.sh proxstar -podman run --rm -it --network=proxstar --name=proxstar -p 8000:8000 -p 8001:8001 --env-file=HACKING/.env --entrypoint='["gunicorn", "proxstar:app", "--bind=0.0.0.0:8000"]' proxstar diff --git a/HACKING/stop_env.sh b/HACKING/stop_env.sh deleted file mode 100755 index 304e996..0000000 --- a/HACKING/stop_env.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash -podman kill proxstar -podman kill proxstar-rq -podman kill proxstar-rq-scheduler -podman stop proxstar-redis -podman stop proxstar-postgres