cheat.sh icon indicating copy to clipboard operation
cheat.sh copied to clipboard

Offline Mode

Open ErezBinyamin opened this issue 4 years ago • 2 comments

Add docker container that locally hosts cheat.sh server which uses a database of pre-downloaded cheat sheets and does not use the web at all. The container should ideally not need to be rebuilt when a new cheat-sheet is added or an old one is edited.

Suggested offline mode features:

  • [ ] Docker container web server
  • [ ] Configuration file pointing to local cheat sheet repos
  • [ ] Edit configuration live
  • [ ] ZERO external connections (100% local)
  • [ ] Template cheat sheets for different concepts (CLI commands, API docs, algorithms, communication protocols...) - Might be good to add this to the main cheat.sh too

Use Case

I have a network of machines I like to use to test out malware from The Zoo. I always keep this network isolated from my other machines. I often find myself in need of cheat.sh and would like to have a local version running in my isolated environment.

ErezBinyamin avatar Aug 08 '20 04:08 ErezBinyamin

I just discovered the offline_usage branch. docker-compose up fails on that branch. Is this already a WIP? It seems the last commit was almost a year ago. Is this the place for me to start developing?

ErezBinyamin avatar Aug 08 '20 11:08 ErezBinyamin

I am finally back to my opensource projects. I hope that now I will have more time for them. Fully agree with the steps you've described, just one minor thing: docker is option, and not always needed. Yes it is good to have it in a docker image, but it is shouldn't be the only possible option. Actually, it should be possible to use cheat.sh offline without docker too. Basically, it is already possible. Take a look at #14 and #98 for details

chubin avatar Oct 12 '20 15:10 chubin