Communis

Lotus communis is translated from Latin to which means "a general or common place", such as a statement of proveberial wisdom. Commonplace books are personal notebooks used to compile any information the owner finds interesting or useful.

Build

1. ./build.sh -b

Container

1. ./build.sh -b -c

Installation

Linux Installation

1. Download linux binary to /opt/communis/bin

2. Create a system user

sudo useradd --system --no-create-home communis-runner

3. Create a data directory

mkdir -p /var/opt/communis
chown communis-runner:communis-runner /var/opt/communis

4. Generate systemd unit file and start service

communis generate systemd-unit -username communis-runner > /etc/systemd/system/communis.service
systemctl daemon-reload
systemctl enable communis

Docker

1. Pull image

docker pull ghcr.io/asc521/communis:{TAG_VERSION}

Docker Compose

communis:
	container_name: communis
	image: ghcr.io/asc521/communis:{TAG_VERSION}
	command: serve
	volumes:
		~/.config/communis:/etc/opt/communis
		~/.local/share/communis:/var/opt/communis
	ports:
		6789:6789
	restart:
		unless-stopped

Podman

1. Pull container image

podman pull ghcr.io/asc521/communis:{TAG_VERSION}

2. Create volume to persist application data

podman volume communis-data

3. Run container directory

podman run \ 
-p 6789:6789 \
-v communis-data:/var/opt/communis \
-v ~/.config/communis:/etc/opt/communis \
ghcr.io/asc521/communis:{TAG_VERSION} serve

4. Generate systemd unit file for automated management of application

mkdir -p ~/.config/containers/systemd
podman run ghcr.io/asc521/communis:{TAG_VERSION} generate systemd-container > ~/.config/containers/systemd/communis.container
systemctl --uesr daemon-reload
systemctl --user enable communis.service

Uninstall

Linux

1. sudo communis uninstall