1
0
mirror of https://github.com/strongdm/comply synced 2024-11-22 15:44:55 +00:00

doc enhancements

This commit is contained in:
Justin McCarthy 2019-03-16 00:28:08 -07:00
parent ef7a4092a7
commit e8d6d536a8
No known key found for this signature in database
GPG Key ID: 900437410E142A48
2 changed files with 9 additions and 3 deletions

View File

@ -113,6 +113,7 @@ minor-release: release-env minor release
docker-release: docker-release:
docker build --build-arg COMPLY_VERSION=`cat VERSION` -t strongdm/comply . docker build --build-arg COMPLY_VERSION=`cat VERSION` -t strongdm/comply .
docker push strongdm/comply
patch: clean gitsem patch: clean gitsem
gitsem -m "increment patch for release (via Makefile)" patch gitsem -m "increment patch for release (via Makefile)" patch

View File

@ -83,13 +83,18 @@ COMMANDS:
Comply is currently only released for Linux and macOS, however from other operating systems it's possible to run using Docker: Comply is currently only released for Linux and macOS, however from other operating systems it's possible to run using Docker:
``` ```
# first build a copy of the container using the included Dockerfile in the root of this project # first pull the latest published docker image
$ docker build -t comply . $ docker pull strongdm/comply
# from an empty directory that will contain your comply project # from an empty directory that will contain your comply project
$ docker run -it --rm -v "$PWD":/source comply $ docker run --rm -v "$PWD":/source -p 4000:4000 -it strongdm/comply
root@ec4544732298:/source# comply init root@ec4544732298:/source# comply init
✗ Organization Name: ✗ Organization Name:
# serve content live from an established project
$ docker run --rm -v "$PWD":/source -p 4000:4000 -it strongdm/comply
root@ae4d499583fc:/source# comply serve
Serving content of output/ at http://127.0.0.1:4000 (ctrl-c to quit)
``` ```
For Windows users, replace $PWD with the full path to your project directory For Windows users, replace $PWD with the full path to your project directory