thedevsaddam/doc-box repository overview

⁠Doc-Box (Beta)

You can run a self hosted API documentation server for your team. It's really easy to run the doc-box.

Run a demo docker run -p 9000:9000 thedevsaddam/doc-box:latest, open http://localhost:9000/ on your borwser and login with username: root, password: 12345

⁠Installation Guide

⁠config.yaml

app:
  name: "API Box"
  dir: "./files"
  port: 9000
  session_expire: 120 #minutes
  # user's list who have permissions to add/update/delete docs
  crud:
    - root
    - user_a

auth_secrets:
  root: 12345
  user_a: password_a
  user_b: password_b

The config.yaml file contains the permissions and other configurations to run the server

⁠Installation Steps

1. Make a directory in hostmachine $ mkdir myfiles
2. CD to the directory $ cd myfiles
3. Make a config.yaml file and copy the above config.yaml configurations. Modify your auth_secrets and crud
4. Run the command $ docker run -d -p 9000:9000 -v $(pwd):/files thedevsaddam/docgen:latest
5. Open http://localhost:9000/ from your browser

⁠Repository

API-Docgen⁠ don't forget to give a star!

⁠Screenshots