{"id":18931965,"url":"https://github.com/crflynn/arcade","last_synced_at":"2025-09-14T22:37:25.920Z","repository":{"id":90650398,"uuid":"210035572","full_name":"crflynn/arcade","owner":"crflynn","description":"Static hosting service for centralized private documentation across multiple languages","archived":false,"fork":false,"pushed_at":"2023-02-09T20:35:32.000Z","size":15,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-31T20:17:30.470Z","etag":null,"topics":["docs","documentation","hosting","multiple-languages","versioning"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crflynn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2019-09-21T18:35:40.000Z","updated_at":"2020-09-22T21:42:25.000Z","dependencies_parsed_at":"2023-03-22T18:18:47.012Z","dependency_job_id":null,"html_url":"https://github.com/crflynn/arcade","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crflynn%2Farcade","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crflynn%2Farcade/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crflynn%2Farcade/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crflynn%2Farcade/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crflynn","download_url":"https://codeload.github.com/crflynn/arcade/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239930089,"owners_count":19720265,"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","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":["docs","documentation","hosting","multiple-languages","versioning"],"created_at":"2024-11-08T11:47:30.686Z","updated_at":"2025-02-20T23:26:45.885Z","avatar_url":"https://github.com/crflynn.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# arcade\n\n[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/crflynn/arcade)](https://hub.docker.com/r/crflynn/arcade)\n\n`arcade` is a (very) basic web service written in Go for publishing static software documentation (sphinx, exdoc, cratedocs) from multiple projects with multiple versions across multiple languages. The service is meant to be used by private teams and is (optionally) secured by basic auth.\n\nTo launch the service locally, clone the repo and run\n\n```bash\nmake build\nmake serve\n```\n\nor using the Dockerhub image\n\n```\ndocker pull crflynn/arcade\ndocker run -p 6060:6060 -it crflynn/arcade\n```\n\nTo see the home page visit\n\n```bash\nhttp://localhost:6060/\n```\n\nIf you are running from a cloned repo using ``make``, you will be prompted for a username and password (default is admin:admin from docker-compose.yml). These are specified by environment variables along with the docs root directory and port.\nTo override the default environment variables use:\n\n```bash\ndocker run -p 6060:6060 \\\n    -e ARCADE_PORT='6060' \\\n    -e ARCADE_DOCROOT='/docs' \\\n    -e ARCADE_USERNAME='username' \\\n    -e ARCADE_PASSWORD='password' \\\n    -it crflynn/arcade\n```\n\nTo push new documentation, tar the docs contents and submit a PUT request:\n\n```bash\n# Navigate into the docs build directory (where index.html is).\n# This will differ depending on language\n# but the point is that we assume the docs are already built.\n# The example here uses the default sphinx build dir for html\ncd docs/_build/html\n# create a tar file of the contents excluding the top folder\ntar -czf ../myproject.tar.gz .\ncd ..\ncurl -u username:password -X PUT 'http://localhost:6060/docs/myproject/latest' --upload-file myproject.tar.gz\ncurl -u username:password -X PUT 'http://localhost:6060/docs/myproject/v1.2.3' --upload-file myproject.tar.gz\n```\n\nTo delete documentation, submit a DELETE request to the project and/or version path which should be removed.\n\n```bash\n# delete a single version\ncurl -u username:password -X DELETE 'http://localhost:6060/docs/myproject/v1.2.3'\n# delete an entire project\ncurl -u username:password -X DELETE 'http://localhost:6060/docs/myproject'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrflynn%2Farcade","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrflynn%2Farcade","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrflynn%2Farcade/lists"}