Skip to content
This repository has been archived by the owner on Jan 2, 2023. It is now read-only.

Better documentation (for setting up HonSSH, etc) #82

Open
unixfox opened this issue Oct 30, 2016 · 6 comments
Open

Better documentation (for setting up HonSSH, etc) #82

unixfox opened this issue Oct 30, 2016 · 6 comments

Comments

@unixfox
Copy link
Contributor

unixfox commented Oct 30, 2016

The actual documentation is not user friendly, we should improve the documentation by creating:

  • a complete tutorial for each setup
  • a complete tutorial to create a special honeypot Docker image
  • another thing ?

I added an initial new page for Honssh using Docker: https://github.com/tnich/honssh/wiki/Setup-using-Docker and a troubleshooting section: https://github.com/tnich/honssh/wiki/Setup-using-single-static-machine#troubleshooting.

@tnich If the organization of the pages do not please you, feel free to change it.

@tnich
Copy link
Owner

tnich commented Oct 30, 2016

Thanks @unixfox, they look great. I really appreciate your time and effort.

Eventually I want to make the documentation more detailed and move it over to: https://docs.honssh.com/en/latest/

I'll make it more of a priority now 😄

@unixfox
Copy link
Contributor Author

unixfox commented Nov 7, 2016

That's a great idea to use a dedicated tool for the wiki.
I'll check if readthedocs is the best tool or if there are some other alternatives that may be better.

@ecthros
Copy link

ecthros commented Feb 26, 2017

I've been using HonSSH for a class (the students make a bunch of honeypots and do research on them throughout the semester). We're forced to use OpenVZ, so I've spent quite a bit of time writing documentation for setting it up specifically with OpenVZ. I know OpenVZ may be a little outdated, but could you give me one of your email addresses so I can send it to you?

@robputt
Copy link
Collaborator

robputt commented Feb 26, 2017

If you are in the ranks of the cool kids maybe we could make a one click Kubernetes deployment for HonSSH. This would make deployment of HonSSH to Google Cloud, AWS or private Kubernetes clusters super easy. I'd be up for helping out here :-), and then we can probably ditch off the documentation altogether 😂. Ok, sure... for those who wanna put it on a box under their desk we probably should have some docs. And wow, OpenVZ is a blast from the past, how are you getting on with support for only uber old kernel versions?

@ecthros
Copy link

ecthros commented Feb 27, 2017

It's a tough time. I think my students hate me :D

@tnich
Copy link
Owner

tnich commented Feb 27, 2017

@ecthros - Sounds like an interesting class! The documentation would be greatly received, if you could email it to the address at the top of every code file, that would be great 😄

Many thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants