{"id":21314452,"url":"https://github.com/polyconseil/dokang","last_synced_at":"2025-08-16T17:05:42.463Z","repository":{"id":17671063,"uuid":"20475805","full_name":"Polyconseil/dokang","owner":"Polyconseil","description":"Lightweight web document repository with a search engine","archived":false,"fork":false,"pushed_at":"2023-02-17T10:04:22.000Z","size":186,"stargazers_count":5,"open_issues_count":2,"forks_count":3,"subscribers_count":41,"default_branch":"master","last_synced_at":"2025-07-12T01:31:50.266Z","etag":null,"topics":["documentation","python","search"],"latest_commit_sha":null,"homepage":"https://dokang.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Polyconseil.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-06-04T08:29:51.000Z","updated_at":"2023-03-22T11:49:18.000Z","dependencies_parsed_at":"2025-07-13T03:02:28.274Z","dependency_job_id":null,"html_url":"https://github.com/Polyconseil/dokang","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/Polyconseil/dokang","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Fdokang","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Fdokang/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Fdokang/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Fdokang/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Polyconseil","download_url":"https://codeload.github.com/Polyconseil/dokang/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Polyconseil%2Fdokang/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270742043,"owners_count":24637504,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","python","search"],"created_at":"2024-11-21T18:13:02.459Z","updated_at":"2025-08-16T17:05:42.439Z","avatar_url":"https://github.com/Polyconseil.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. Edit with care, this file is included in the documentation.\n\nDokang\n######\n\nDokang is a lightweight documentation repository. It is a web\napplication that:\n\n1. Provides an endpoint for clients to upload their documentation.\n\n   Sending documentation to Dokang is as simple as issuing a POST\n   query such as:\n\n   .. code:: bash\n\n       $ curl \\\n         -X POST \\\n         --form name=project_name \\\n         -F \":action=doc_upload\" \\\n         -F content=@../documentation.zip \\\n         http://dokang:my-secret-token@dokang.example.com/upload\n\n2. Serves a home page with a list of all documentations and a simple\n   search form that lets users search in HTML, text and PDF\n   files. Other formats can be handled through the use of extensions.\n\n3. Serves all documentations.\n\nDokang also comes with a command line interface. It is lightweight in\nthe sense that it is merely a wrapper around the Whoosh search engine\nwith a very simple HTML text indexer. It can be extended to retrieve\ncontent from other types of files (such as PDF).\n\nDokang is similar to Readthedocs (although Readthedocs has a much\nbroader set of features) but provides a global search across all\nhosted documentations. All of this is provided with a simple setup\nthat does not need any relational database.\n\nWe (`Polyconseil`_) use it to search through the `Sphinx\n\u003chttp://sphinx-doc.org/\u003e`_-generated documentation of all our\nprojects. However, it may be used to host any kind of documentation.\n\n.. _Polyconseil: https://www.polyconseil.fr/\n\n\nBuild and run your own docker image\n-----------------------------------\n\nTo build your own image:\n\n.. code:: bash\n\n    $ docker build -t dokang .\n\nTo run the image:\n\n.. code:: bash\n\n    $ docker run --rm -e DOKANG_UPLOAD_TOKEN=my_little_secret \\\n      -e DOKANG_NAME='My docs' \\\n      -e DOKANG_DESCRIPTION='Documentations of all my projects' \\\n      -e DOKANG_SERVER_TRUSTED_PROXY=129.14.12.1  # Optional: the IP address of the proxy to pass to waitress server's trusted_proxy\n      -p 8080:6543\n      dokang\n\nGo to http://localhost:8080/ in your browser, you should see the list of documentations.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyconseil%2Fdokang","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolyconseil%2Fdokang","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyconseil%2Fdokang/lists"}