Paperwork is an open-source, self-hosted alternative to services like Evernote ®, Microsoft OneNote ® or Google Keep ®
This branch contains the second iteration of Paperwork, which is a complete rewrite. Not only is it based on another framework - it is based on a completely different technology stack. It is in its very early development phase and not yet usable.
If you were looking for the Laravel-based version 1 of Paperwork, please check out this branch. Version 1 is not in active development anymore!
Feel free to check out this branch and get involved with what’s there already to get an idea of where Paperwork is heading. Also check out the current issues to see what needs to be done or suggest what could be done in future iterations.
Also, you can join the official chatroom and participate there.
Info: 99% of the action happens inside the other repositories! This repository only contains of the one-click-deployment of Paperwork!
This repository is structuring and unifying all required components for Paperwork.
$ git clone email@example.com:paperwork/paperwork.git
In order to easily get Paperwork running as a Docker stack, utilizing whichever orchestrator you’d like, this repository comes with a handy Makefile. Let’s have a look at it:
$ make help
Launching the Paperwork can be done by make
-ing the deploy` target:
$ make deploy
The Makefile then takes care of initializing Swarm, in case you haven’t done that already, creating the encrypted network (
papernet) and deploying the Paperwork stack on top of it.
In order to stop/remove the whole stack, simply use the
$ make undeploy
Note: This won’t make your Docker host leave Swarm again, in case it wasn’t running in Swarm mode before deploying! If you’d like to turn off Swarm, you have to manually do so.
If you’d like to use a different orchestrator for stack deployment, you can do so by setting the
ORCHESTRATOR variable on deploy:
$ make deploy ORCHESTRATOR=kubernetes
Please refer to the individual services’ repositories in order to get more information on how to contribute.
Here are the main repositories of Paperwork v2:
paperwork: This repository, containing the one-click-deployment and overall documentation
paperwork.ex: Elixir SDK for building Paperwork services
service-configs: Configurations service that stores instance configs and provides them through an internal endpoint to other services
service-users: Users service that stores user information and provides endpoints for users to register, login and update their information
service-notes: Notes service that stores all the user’s notes
web: Angular-based web front-end for Paperwork
As for now, all tasks/issues are being collected inside this repository, just to keep it simple. On a long term, tasks/issues will be transferred into the related service’s repository, in order to be able to reference them through git commits.