communityhoneynetwork / chn-docs Goto Github PK

• Understanding docker & docker-compose
• basic docker commands
• Installing docker
  ** user can run docker
  ** Linux (Ubuntu/RHEL)
  ** Mac
• Network accessibility
  ** Private v/s Public
  ** NAT/PAT
  ** CHN server must be available to all honeypots + wherever you want to access + Let'sEncrypt

Document preference to us OS package for Docker-compose where possible. Newest versions from Docker often contain unresolved issues

• more discussion about why run honeypots
• overall project goals
• simple architecture diagram
• Discussion of honeypot types
• shortcut link to start installing

Add documentation for UHP https://github.com/MattCarothers/uhp

May also require some changes on the CHN-Server side, but we want documentation for how a user can insert their own certificate into the CHN-Server container.

more detail on how to BYO and confirm that container sees your cert

• bonus for troubleshooting here as well

Documentation for hpfeeds-logger references hpfeeds-cif several times instead. These instances of the string "hpfeeds-cif" should be changed to "hpfeeds-logger"

Create a page dedicated to troubleshooting

• "Server doesn't work"
  ** docker running?
  ** container running
  ** logs from container?
• Cert configuration troubleshooting
• Getting help!
  ** Github issues
  ** GItter

Add tagging/versions to documentation. Will allow for old documentation to remain, as well as allowing new versions to be prepared in tandem with new code versions.

Issue

Following the "Your First Honeypot" section of the installation guide results in a failed deployment of the cowrie honeypot. This can be seen by using the command

sudo docker-compose ps

which results in the output

     Name               Command           State      Ports
----------------------------------------------------------
cowrie_cowrie_1   /code/entrypoint.sh   Restarting

Error Logs

For reference, this command was used:

sudo docker-compose logs --tail 50 --timestamps

Output

Note that both ports 80 and 443 are open and listening.

https://communityhoneynetwork.readthedocs.io/en/stable/prod_security/#use-of-https has:

SERVER_BASE_URL='https://chn.my.org

It's either missing or has an extra '

• "have you installed server" link back
• prerequisite link back
• deploying honeypots on non-intel architectures
• ensure proper architecture for deployment

• Adjust to reflect build script
• Rename to "CHN Server Install"
• Link back to Pre-Requisite page
• Detailed discussion on how cert deployment works in CHN
• Call out how to include admin secret in sysconfig file or use passwd change after start