diff --git a/README.md b/README.md index e11cbc6..b8a0a26 100644 --- a/README.md +++ b/README.md @@ -189,52 +189,20 @@ The route requires [Docker](https://docs.docker.com/get-docker/) and [Docker Com 1. Edit the `data/.opencanary.conf` file to enable, disable or customize the services that will run. 1. Edit the `ports` section of the `docker-compose.yml` file to enable/disable the desired ports based on the services you have enabled in the config file. -1. Build and run the container. - - To run the latest Docker image (based on the code on a given branch) run: - ```bash - docker-compose up -d --build latest - ``` - To run a Docker image based on what has been released in Pypi, run: +1. Run the container. ```bash - docker-compose up -d --build stable + docker-compose up latest ``` -To view the logs run `docker-compose logs latest` or `docker-compose logs stable`. +To view the logs run `docker-compose logs latest`. To stop the container run `docker-compose down`. -### With Docker - -This route requires [Docker](https://docs.docker.com/get-docker/) to be installed. - -> **Note** -> The portscan module is automatically disabled for Dockerised OpenCanary. - -1. Edit the `data/.opencanary.conf` file to enable, disable or customize the services that will run. -1. Build a Docker image to run. - - To build the latest Docker image (based on the code on a given branch) run: +To build your own Docker OpenCanary using `docker compose`, head over to our [wiki](https://github.com/thinkst/opencanary/wiki/Using-Dockerised-OpenCanary#building-and-running-your-own-docker-opencanary-image-with-docker-compose) - ```bash - docker build -t opencanary -f Dockerfile.latest . - ``` - - To build a Docker image based on what has been released in Pypi, run: - - ```bash - docker build -t opencanary -f Dockerfile.stable . - ``` -1. Run the Docker image with the following shell command: -``` -# You will need to add/remove the ports you are using by listing them with `-p ##:##` -$ docker run --rm --detach -p 21:21 -p 80:80 -v "${PWD}/data/.opencanary.conf":"/root/.opencanary.conf" --name opencanary opencanary -``` - -To view the logs run `docker logs opencanary`. - -To stop the container, run `docker stop opencanary`. +### With Docker +Please head over our dedicated Docker [wiki](https://github.com/thinkst/opencanary/wiki/Using-Dockerised-OpenCanary#building-and-running-your-own-docker-opencanary-image-with-docker) for everything Dockerised OpenCanary. ## Documentation * The [Wiki](https://github.com/thinkst/opencanary/wiki) contains our FAQ. diff --git a/docker-compose.yml b/docker-compose.yml index a5631da..12ee7fa 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -4,6 +4,8 @@ x-common: &common restart: unless-stopped volumes: - ./data/.opencanary.conf:/root/.opencanary.conf + # uncomment below if running Samba + # - /var/log/samba-audit.log:/var/log/samba-audit.log image: "opencanary" network_mode: "host" ports: