Skip to content

Commit 0f54e62

Browse files
committed
update dev environment setup instructions
1 parent 308dc21 commit 0f54e62

3 files changed

Lines changed: 11 additions & 22 deletions

File tree

HACKING/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,26 @@ source venv/bin/activate
2020

2121
### Podman Environment Instructions
2222

23-
1. Build your containers. The `proxstar` container serves as proxstar, rq, rq-scheduler, and VNC. The `proxstar-postgres` container sets up the database schema.
23+
1. Copy `.env.template` to `.env` and fill it out with the help of an RTP
2424

25-
`mkdir HACKING/proxstar-postgres/volume`
26-
27-
`podman build . --tag=proxstar`
25+
2. Create volume for postgres
2826

29-
`podman build HACKING/proxstar-postgres --tag=proxstar-postgres`
27+
`mkdir HACKING/proxstar-postgres/volume`
3028

31-
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.
29+
3. Build the proxstar container and launch it on your system.
3230

33-
3. Run it. This sets up redis, postgres, rq, and proxstar.
31+
`podman compose up -d`
3432

35-
`./HACKING/launch_env.sh`
33+
To access the proxstar WebUI, go to https://localhost:8000
3634

3735
4. To stop all containers, use the provided script
3836

39-
`./HACKING/stop_env.sh`
37+
`podman compose down`
38+
39+
## Setting up a full dev environment (Advanced)
4040

41-
## Setting up a full dev environment
41+
> [!INFO]
42+
> This is not required for most contributors
4243
4344
If you want to work on Proxstar using a 1:1 development setup, there are a couple things you're going to need
4445

HACKING/launch_env.sh

Lines changed: 0 additions & 6 deletions
This file was deleted.

HACKING/stop_env.sh

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)