https://github.com/crflynn/arcade
Static hosting service for centralized private documentation across multiple languages
https://github.com/crflynn/arcade
docs documentation hosting multiple-languages versioning
Last synced: 26 days ago
JSON representation
Static hosting service for centralized private documentation across multiple languages
- Host: GitHub
- URL: https://github.com/crflynn/arcade
- Owner: crflynn
- Created: 2019-09-21T18:35:40.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-09T20:35:32.000Z (over 2 years ago)
- Last Synced: 2024-12-31T20:17:30.470Z (9 months ago)
- Topics: docs, documentation, hosting, multiple-languages, versioning
- Language: Go
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# arcade
[](https://hub.docker.com/r/crflynn/arcade)
`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.
To launch the service locally, clone the repo and run
```bash
make build
make serve
```
or using the Dockerhub image
```
docker pull crflynn/arcade
docker run -p 6060:6060 -it crflynn/arcade
```
To see the home page visit
```bash
http://localhost:6060/
```
If 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.
To override the default environment variables use:
```bash
docker run -p 6060:6060 \
-e ARCADE_PORT='6060' \
-e ARCADE_DOCROOT='/docs' \
-e ARCADE_USERNAME='username' \
-e ARCADE_PASSWORD='password' \
-it crflynn/arcade
```
To push new documentation, tar the docs contents and submit a PUT request:
```bash
# Navigate into the docs build directory (where index.html is).
# This will differ depending on language
# but the point is that we assume the docs are already built.
# The example here uses the default sphinx build dir for html
cd docs/_build/html
# create a tar file of the contents excluding the top folder
tar -czf ../myproject.tar.gz .
cd ..
curl -u username:password -X PUT 'http://localhost:6060/docs/myproject/latest' --upload-file myproject.tar.gz
curl -u username:password -X PUT 'http://localhost:6060/docs/myproject/v1.2.3' --upload-file myproject.tar.gz
```
To delete documentation, submit a DELETE request to the project and/or version path which should be removed.
```bash
# delete a single version
curl -u username:password -X DELETE 'http://localhost:6060/docs/myproject/v1.2.3'
# delete an entire project
curl -u username:password -X DELETE 'http://localhost:6060/docs/myproject'
```