DOCAT alternatives and similar software solutions
Based on the "Document Management" category.
Alternatively, view DOCAT alternatives based on common mentions on social networks and blogs.
-
Paperless-ng
A supercharged version of paperless: scan, index and archive all your physical documents -
Papermerge
Open Source Document Management System for Digital Archives (Scanned Documents) -
Teedy
Lightweight document management system packed with all the features you can expect from big expensive solutions -
Docspell
Assist in organizing your piles of documents, resulting from scanners, e-mails and other sources with miminal effort. -
EveryDocs
A simple Document Management System for private use with basic functionality to organize your documents digitally -
paper{s}pace
a small web application to manage all your offline documents. Provides a searchable storage for your documents and reminds you of upcoming tasks.
Static code analysis for 29 languages.
Do you think we are missing an alternative of DOCAT or a related project?
|
OPS - Build and Run Open Source Unikernels
sponsored
github.com/nanovms
|
Popular Comparisons
|
Less time debugging, more time building
sponsored
scoutapm.com
|
README
[docat](doc/assets/docat-teaser.png)
Host your docs. Simple. Versioned. Fancy.
Getting started
The simplest way is to build and run the docker container, you can optionally use volumes to save state:
# run container in background and persist data (docs, nginx configs)
# use 'ghcr.io/docat-org/docat:unstable' to get the latest changes
mkdir -p docat-run/db && touch docat-run/db/db.json
docker run \
--detach \
--volume $PWD/docat-run/doc:/var/docat/doc/ \
--volume $PWD/docat-run/locations:/etc/nginx/locations.d/ \
--volume $PWD/docat-run/db/db.json:/app/docat/db.json \
--publish 8000:80 \
ghcr.io/docat-org/docat
Go to localhost:8000 to view your docat instance:
[docat screenshot](doc/assets/docat-screenshot.png)
If you want to run the application different than in a docker container, look at the [backend](docat/README.md) and [web](web/README.md) docs.
Push documentation to docat
The preferred way to push documentation to a docat server is using the docatl command line application:
docatl push --host http://localhost:8000 /path/to/your/docs PROJECT VERSION
There are also docker images available for CI systems.
Using standard UNIX command line tools
If you have static html documentation or use something like mkdocs, sphinx, ... to generate your documentation, you can push it to docat:
# create a zip of your docs
zip -r docs.zip /path/to/your-docs
# upload them to the docat server (replace PROJECT/VERSION with your projectname and the version of the docs)
curl -X POST -F "[email protected]" http://localhost:8000/api/PROJECT/VERSION
When you have multiple versions you may want to tag some version as latest:
# tag the version VERSION of project PROJECT as latest
curl -X PUT http://localhost:8000/api/PROJECT/VERSION/tags/latest
Advanced config.json
It is possible to configure some things after the fact.
- Create a
config.jsonfile - Mount it inside your docker container
--volume /path/to/config.json:/var/www/html/config.json
Supported config options:
- headerHTML