Doc-hoarder is a document management system.
Born out of the necessity of archiving web pages for when the underlying site eventually disappears.
After installing dependencies using:
go get -v ./...
use the build.go script to compile the project. It has a few important options:
--base-url=https://x.y.z/f/b/: Set this to the location at which the application will be hosted. (The compiled extension needs to know its own update URL in advance.)
A full example would be:
go run build.go --base-url=https://example.org/doc-hoarder/
Use the --development and --quick flags to create a development build. Static assets are loaded from the filesystem rather than embedded in the binary.
The optional flag --watch will watch the source tree, and re-run the compilation automatically if changes are detected. When using this, the optional flag --run will start and restart the application automatically. Any arguments provided after a double-dash (--) will be passed to the application.
A typical development run would look like:
go run build.go --base-url=https://example.org/doc-hoarder/ --development --quick --watch --run --
Extensions will be built in an unpacked state in build/extensions/*. Use web-ext run from an extension's directory there to debug the extension code.
In order to run the browser extension, it will need to be signed by Mozilla. Follow the instructions for self-distribution.
The XPI files you'll need to upload to Mozilla can be found in the directory web/assets/extensions. After getting approved, place the signed version in web/assets/extensions/_signed, and re-run the build script.
- This project includes normalize.css by Nicolas Gallagher, licensed under the MIT license.
- This project includes the Nord Theme by Arctic Ice Studio