Categorygithub.com/sparkymat/archmark
repositorypackage
2.1.0+incompatible
Repository: https://github.com/sparkymat/archmark.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

ArchMark .github/workflows/ci.yml

ArchMark is a bookmark manager that archives the bookmarked page using Monolith. It consists of the main web proccess as well as a worker that downloads the web page for archival.

Installation

The simplest way to use ArchMark would be to use docker-compose. If you have Docker and Docker Compose installed, you can follow the steps below to get up and running:

  1. mkdir archmark
  2. cd archmark
  3. curl https://raw.githubusercontent.com/sparkymat/archmark/main/docker-compose.prod.yml -o docker-compose.yml
  4. mkdir -p data/db
  5. mkdir -p data/faktory
  6. mkdir -p data/archive
  7. docker-compose pull
  8. docker-compose up

Alternatively, you can build and run from the code with:

  1. git clone https://github.com/sparkymat/archmark
  2. cd archmark
  3. docker-compose build
  4. docker-compose up

P.S: Don't forget to edit the docker-compose.yml file, and update the value of JWT_SECRET and SESSION_SECRET to something more secure. You can generate secrets using openssl like this:

openssl rand -hex 32

N.B: Everything in the download folder (configured using DOWNLOAD_FOLDER) will be served under /uploads/ sub-path.

Configuration

Both the app and the worker are configured using environment variables.

VariableDescription
DISABLE_REGISTRATIONSet to 'true' if you want to disable registrations