@@ -11,29 +11,29 @@ queues. More information on [the wiki][].
1111* Python 3.13+
1212* pip or [ uv] ( https://docs.astral.sh/uv/ ) (to install dependencies)
1313* PostgreSQL (for production; testing environments can use sqlite)
14- * docker-compose (to stand up a local Docker-based environment)
14+ * docker (to stand up a local Docker-based environment)
1515
1616## Setup
1717
1818### Docker Compose
1919
2020The easiest way to start a local instance of PulseGuardian is via
21- [ docker- compose] [ ] :
21+ [ docker compose] [ ] :
2222
23- $ docker- compose up --build
23+ $ docker compose up --build
2424
2525This will launch four containers: a RabbitMQ instance, a PostGreSQL database,
2626the PulseGuardian web process, and the PulseGuardian daemon
2727(` guardian.py ` ). Pressing control-C will stop all the containers.
28- You can also add ` -d ` to run docker- compose in the background, in
29- which case you will need to run ` docker- compose down ` to stop the containers.
28+ You can also add ` -d ` to run docker compose in the background, in
29+ which case you will need to run ` docker compose down ` to stop the containers.
3030
3131Known issue: a local install of PostGreSQL will likely result in a port
3232conflict.
3333
3434The PulseGuardian code is mounted as ` /code ` in the web and daemon
3535containers. You can edit the code locally and restart the container(s) to
36- pick up changes: ` docker- compose restart web ` and/or `docker- compose
36+ pick up changes: ` docker compose restart web ` and/or `docker compose
3737restart guardian`. The RabbitMQ cluster and PulseGuardian database data are
3838preserved across restarts as via Docker volumes.
3939
@@ -155,7 +155,7 @@ For production, the web app can be run with [gunicorn][] and such.
155155## Testing
156156
157157TODO: This process should be updated to run the tests with a
158- docker- compose environment.
158+ docker compose environment.
159159
160160Tests are automatically run against the GitHub repository via [ Travis
161161CI] [ ] . Before submitting a patch, it is highly recommended that you
@@ -165,7 +165,7 @@ pulseguardian repo.
165165For local testing, PulseGuardian uses docker to run its test
166166suite. Please follow the [ docker installation docs] [ ] on how to
167167install it in your system. Note that these tests are not yet hooked
168- up to the environment created with ` docker- compose ` above.
168+ up to the environment created with ` docker compose ` above.
169169
170170With docker installed and configured appropriately, run
171171
@@ -218,7 +218,7 @@ used for all installations, including for local development. The database URL,
218218
219219To migrate the database,
220220
221- * Install the alembic package (if you haven't yet): ` pip install -r requirements.txt ` (or ` uv pip install -r requirements.txt ` if using uv)
221+ * Install the dependencies (if you haven't yet): ` uv pip install -e ".[dev]" `
222222* Run ` alembic upgrade head `
223223
224224## Deployment
@@ -229,7 +229,7 @@ To set this up, run `heroku git:remote -a pulseguardian`.
229229Then just push the latest ` main ` branch to the ` heroku ` remote: ` git push heroku main `
230230
231231[ the wiki ] : https://wiki.mozilla.org/Auto-tools/Projects/Pulse/PulseGuardian
232- [ docker- compose ] : https://docs.docker.com/compose/
232+ [ docker compose ] : https://docs.docker.com/compose/
233233[ HACKING.md ] : https://hg.mozilla.org/automation/mozillapulse/file/tip/HACKING.md
234234[ Travis CI ] : https://travis-ci.org/mozilla/pulseguardian
235235[ gunicorn ] : https://www.digitalocean.com/community/articles/how-to-deploy-python-wsgi-apps-using-gunicorn-http-server-behind-nginx
0 commit comments