Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 11 additions & 10 deletions HACKING/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 0 additions & 6 deletions HACKING/launch_env.sh

This file was deleted.

6 changes: 0 additions & 6 deletions HACKING/stop_env.sh

This file was deleted.