Skip to content

Commit dee920f

Browse files
committed
Update README.md docs
Update some docker commands, link to docker engine and compose install pages, update status badge.
1 parent 2e2e0d6 commit dee920f

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
# vbos-backend
22

3-
[![Build Status](https://travis-ci.org/developmentseed/vbos-backend.svg?branch=master)](https://travis-ci.org/developmentseed/vbos-backend)
3+
[![Docker](https://github.com/developmentseed/vbos-backend/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/developmentseed/vbos-backend/actions/workflows/docker-publish.yml)
44
[![Built with](https://img.shields.io/badge/Built_with-Cookiecutter_Django_Rest-F7B633.svg)](https://github.com/agconti/cookiecutter-django-rest)
55

66
VBOS Django application and data services. Check out the project's [documentation](http://developmentseed.github.io/vbos-backend/).
77

88
# Prerequisites
99

10-
- [Docker](https://docs.docker.com/docker-for-mac/install/)
10+
- [Docker Engine](https://docs.docker.com/engine/install)
11+
- [Docker Compose](https://docs.docker.com/compose/install)
1112

1213
# Local Development
1314

1415
Start the dev server for local development:
16+
1517
```bash
16-
docker-compose up
18+
cd deploy/
19+
docker compose up
1720
```
1821

1922
Run a command inside the docker container:
2023

2124
```bash
22-
docker-compose run --rm web [command]
25+
docker compose run --rm web [command]
2326
```
2427

2528
# Configuration

deploy/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ All deploy related configuration are in the `deploy/` directory.
88

99
To update or redeploy:
1010
1. First ssh into the server. Keys are in 1PW
11-
2. Fetch code and run migrations.
11+
2. Fetch code and run migrations.
1212
* Activate venv. `. ~/vbos-env/bin/activate`
13-
* `cd vbos-backend && git pull`. `python manage.py migrate`
13+
* `cd ~/vbos-backend && git pull`. `python manage.py migrate`
1414
3. Then run `docker compose -f deploy/vbos/docker-compose.yml pull` to pull the new image. By default the image tag is `main`
1515
4. Then run `docker compose -f deploy/vbos/docker-compose.yml --env-file /home/devseed/vbos-backend/.env up --force-recreate -d --no-deps vbos-backend` — this will start a new container and kill the older one for deploys with no downtime

0 commit comments

Comments
 (0)