aperimau/opencanary repository overview

⁠

⁠OpenCanary Container

Not affiliated with the OpenCanary project.
OpenCanary by Thinkst Applied Research »⁠

Report Bug⁠ · Request Feature⁠

⁠About The Project

There are a few containers for OpenCanary publically available. This is just another one. It's simple, easily updated, and pretty slim.

⁠Built With

I'm lazy so this was made inside VSCode and tested with docker.

• Visual Studio Code⁠
• Docker⁠

⁠Getting Started

There isn't much to do - you need a network, and something to run the container in.

We use VMware ESXi⁠ and for the guest operating system Photon OS⁠.

⁠Prerequisites

Not much - you need docker (or any other suitable container system such as Podman⁠).

• docker

  $ docker --version
  Docker version 20.10.0, build 7287ab3
  

  Copy

⁠Starting OpenCanary using default config

1. Get ready
2. Start the container

   $ docker run -d --network host --name opencanary --restart always aperimau/opencanary
   

   Copy
3. Watch those logs

   docker logs -f opencanary
   

   Copy

⁠Usage

You will get nearly no value out of OpenCanary unless you supply your own configuration file. To run the container and supply your own configuration file - do something like:

  $ docker run -d --network host --name opencanary --restart always -v ~/opencanary.conf:/etc/opencanaryd/opencanary.conf aperimau/opencanary 

For more details about the configuration file, please refer to the OpenCanary Documentation⁠

⁠Roadmap

See the open issues⁠ for a list of proposed features (and known issues).

⁠Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

⁠License

Distributed under the APACHE-2 License. See LICENSE for more information.

⁠Contact

Your Name - @troykelly⁠ - [email protected]⁠

Project Link: https://github.com/aperim/docker-opencanary⁠

⁠Acknowledgements

• GitHub Readme Template⁠