Dotlinker

Description

This Ansible role ensures the doli (dotlinker) CLI is installed (via pkgmgr) and applies dotlinker mappings provided by the calling role.

The role is intentionally generic: it does not know anything about Nextcloud or other apps. It can be included multiple times from different roles, each time with a different set of mappings.

Overview

This role installs and applies dotlinker (doli) mappings (generic role).

Architecture

ARCHITECTURE.md draws Dotlinker from its own metadata: the containers it runs under compose, what changes under swarm, how each volume is backed, and every role it depends on or is depended upon by.

Section

Drawn from

Compose

meta/services.yml

Swarm

meta/services.yml replicas and placement

Volumes

meta/volumes.yml against the NFS decision chain

Dependencies

meta/services.yml and meta/main.yml of every role

Features

  • Automated provisioning: Configured by Ansible without manual steps.

Quick Setup

Development

Clone, set up the workstation, and deploy Dotlinker onto the local stack:

git clone https://github.com/infinito-nexus/core.git
cd core
make onboard
make compose-deploy mode=reinstall apps=dsk-dotlinker full_cycle=false

Production

Install Dotlinker directly onto the target machine: clone the repository, install the OS prerequisites and the repository toolchain, then deploy against localhost over a local connection (no SSH, no container):

git clone https://github.com/infinito-nexus/core.git
cd core
bash scripts/install/package.sh
make install
source scripts/meta/env/load.sh

APP=dsk-dotlinker
DOMAIN="<your-domain>"
TLS_MODE=self_signed
SSH_PUBLIC_KEY="<your-ssh-public-key>"
INVENTORY=inventories/production
infinito administration inventory provision "$INVENTORY" \
  --inventory-file "$INVENTORY/devices.yml" \
  --host localhost \
  --include "$APP" \
  --vars "{\"TLS_MODE\": \"$TLS_MODE\", \"DOMAIN_PRIMARY\": \"$DOMAIN\", \"users\": {\"administrator\": {\"authorized_keys\": [\"$SSH_PUBLIC_KEY\"]}}}"
infinito administration deploy dedicated "$INVENTORY/devices.yml" \
  --password-file "$INVENTORY/.password" \
  --diff -vv

Credits

Kevin Veen-Birkenbach

Part of the Infinito.Nexus Project and maintained by Kevin Veen-Birkenbach. Licensed under the Infinito.Nexus Community License (Non-Commercial).

That licence covers this role. The software it deploys is a separate grant: MIT, under which commercial use is allowed. You owe its authors this much: keep the copyright notice and the licence text. Permission for one of the two is not permission for the other.

Usage

Call this role via include_role and pass mappings through dotlinker_mappings:

  • name: unique mapping id

  • backend: cloud or chezmoi

  • src: source path (original location)

  • dest: destination path (required for cloud)

The role will register mappings using doli add and can optionally run doli pull.

Variables

  • dotlinker_user (required): user to run doli as

  • dotlinker_config_path (default: ~/.config/dotlinker/config.yaml)

  • dotlinker_cli_name (default: doli)

  • dotlinker_package_name (default: doli)

  • dotlinker_replace (default: true): pass --replace to doli add

  • dotlinker_apply (default: true): run doli pull after adding mappings