Dokang¶
Dokang¶
Dokang is a lightweight documentation repository. It is a web application that:
Provides an endpoint for clients to upload their documentation.
Sending documentation to Dokang is as simple as issuing a POST query such as:
$ curl \ -X POST \ --form name=project_name \ -F ":action=doc_upload" \ -F content=@../documentation.zip \ http://dokang:my-secret-token@dokang.example.com/upload
Serves a home page with a list of all documentations and a simple search form that lets users search in HTML, text and PDF files. Other formats can be handled through the use of extensions.
Serves all documentations.
Dokang also comes with a command line interface. It is lightweight in the sense that it is merely a wrapper around the Whoosh search engine with a very simple HTML text indexer. It can be extended to retrieve content from other types of files (such as PDF).
Dokang is similar to Readthedocs (although Readthedocs has a much broader set of features) but provides a global search across all hosted documentations. All of this is provided with a simple setup that does not need any relational database.
We (Polyconseil) use it to search through the Sphinx-generated documentation of all our projects. However, it may be used to host any kind of documentation.
Build and run your own docker image¶
To build your own image:
$ docker build -t dokang .
To run the image:
$ docker run --rm -e DOKANG_UPLOAD_TOKEN=my_little_secret \
-e DOKANG_NAME='My docs' \
-e DOKANG_DESCRIPTION='Documentations of all my projects' \
-e DOKANG_SERVER_TRUSTED_PROXY=129.14.12.1 # Optional: the IP address of the proxy to pass to waitress server's trusted_proxy
-p 8080:6543
dokang
Go to http://localhost:8080/ in your browser, you should see the list of documentations.
Topics¶
- Basics
- Advanced configuration and usage
- Extending Dokang
- Contributing to Dokang
- API
- Change log
- 0.9.5 (2016-12-14)
- 0.9.4 (2016-07-05)
- 0.9.3 (2016-07-04)
- 0.9.2 (2016-04-26)
- 0.9.1 (2016-04-01)
- 0.9.0 (2016-04-01)
- Dokang 0.8.2 (2016-02-24)
- Dokang 0.8.1 (2016-02-24)
- Dokang 0.8.0 (2016-02-24)
- Dokang 0.7.0 (2016-02-01)
- Dokang 0.6.1 (2015-03-03)
- Dokang 0.6.0 (2015-03-03)
- Dokang 0.5.0 (2015-02-18)
- Dokang 0.4.2 (2014-09-01)
- Dokang 0.4.1 (2014-08-27)
- Dokang 0.4.0 (2014-07-04)
- Dokang 0.3.0 (2014-07-04)
- Dokang 0.2.0 (2014-06-24)