LinkWarden

Description / name	Input element
Your domain name

Overview

LinkWarden is a self-hosted collaborative bookmark manager designed to collect, read, annotate, and fully preserve web content. It automatically captures screenshots, PDFs, and HTML files of bookmarked pages to prevent link rot.

Manual

Releases

Community

---

Deployment

sb install sandbox-linkwarden

Usage

Visit https://linkwarden.iYOUR_DOMAIN_NAMEi.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   linkwarden_name: "custom_value"
   

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like linkwarden_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

   Instead, use the corresponding _custom variable (like linkwarden_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

linkwarden_name

# Type: string
linkwarden_name: linkwarden

linkwarden_role_postgres_deploy

# Type: bool (true/false)
linkwarden_role_postgres_deploy: true

linkwarden_role_postgres_name

# Type: string
linkwarden_role_postgres_name: "{{ linkwarden_name }}-postgres"

linkwarden_role_postgres_user

# Type: string
linkwarden_role_postgres_user: "{{ linkwarden_name }}"

linkwarden_role_postgres_password

# Type: string
linkwarden_role_postgres_password: "{{ linkwarden_name }}"

linkwarden_role_postgres_docker_env_db

# Type: string
linkwarden_role_postgres_docker_env_db: "{{ linkwarden_name }}"

linkwarden_role_postgres_docker_image_tag

# Type: string
linkwarden_role_postgres_docker_image_tag: "16-alpine"

linkwarden_role_postgres_docker_image_repo

# Type: string
linkwarden_role_postgres_docker_image_repo: "postgres"

linkwarden_role_postgres_docker_healthcheck

# Type: dict
linkwarden_role_postgres_docker_healthcheck:
  test: ["CMD-SHELL", "pg_isready -d {{ lookup('role_var', '_postgres_docker_env_db', role='linkwarden') }} -U {{ lookup('role_var', '_postgres_user', role='linkwarden') }}"]
  start_period: 20s
  interval: 30s
  retries: 5
  timeout: 5s

linkwarden_role_postgres_paths_folder

# Type: string
linkwarden_role_postgres_paths_folder: "{{ linkwarden_name }}"

linkwarden_role_postgres_paths_location

# Type: string
linkwarden_role_postgres_paths_location: "{{ server_appdata_path }}/{{ linkwarden_role_postgres_paths_folder }}/postgres"

linkwarden_role_web_subdomain

# Type: string
linkwarden_role_web_subdomain: "{{ linkwarden_name }}"

linkwarden_role_web_domain

# Type: string
linkwarden_role_web_domain: "{{ user.domain }}"

linkwarden_role_web_port

# Type: string
linkwarden_role_web_port: "3000"

linkwarden_role_web_url

# Type: string
linkwarden_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='linkwarden') + '.' + lookup('role_var', '_web_domain', role='linkwarden')
                          if (lookup('role_var', '_web_subdomain', role='linkwarden') | length > 0)
                          else lookup('role_var', '_web_domain', role='linkwarden')) }}"

linkwarden_role_dns_record

# Type: string
linkwarden_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='linkwarden') }}"

linkwarden_role_dns_zone

# Type: string
linkwarden_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='linkwarden') }}"

linkwarden_role_dns_proxy

# Type: bool (true/false)
linkwarden_role_dns_proxy: "{{ dns_proxied }}"

linkwarden_role_traefik_sso_middleware

# Type: string
linkwarden_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

linkwarden_role_traefik_middleware_default

# Type: string
linkwarden_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

linkwarden_role_traefik_middleware_custom

# Type: string
linkwarden_role_traefik_middleware_custom: ""

linkwarden_role_traefik_certresolver

# Type: string
linkwarden_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

linkwarden_role_traefik_enabled

# Type: bool (true/false)
linkwarden_role_traefik_enabled: true

linkwarden_role_traefik_api_enabled

# Type: bool (true/false)
linkwarden_role_traefik_api_enabled: true

linkwarden_role_traefik_api_endpoint

# Type: string
linkwarden_role_traefik_api_endpoint: "PathPrefix(`/api`)"

Container

linkwarden_role_docker_container

# Type: string
linkwarden_role_docker_container: "{{ linkwarden_name }}"

Image

linkwarden_role_docker_image_pull

# Type: bool (true/false)
linkwarden_role_docker_image_pull: true

linkwarden_role_docker_image_tag

# Type: string
linkwarden_role_docker_image_tag: "latest"

linkwarden_role_docker_image_repo

# Type: string
linkwarden_role_docker_image_repo: "ghcr.io/linkwarden/linkwarden"

linkwarden_role_docker_image

# Type: string
linkwarden_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='linkwarden') }}:{{ lookup('role_var', '_docker_image_tag', role='linkwarden') }}"

Envs

linkwarden_role_docker_envs_default

# Type: dict
linkwarden_role_docker_envs_default:
  TZ: "{{ tz }}"
  NEXT_PUBLIC_CREDENTIALS_ENABLED: "true"
  STORAGE_FOLDER: "/data"
  NEXTAUTH_SECRET: "{{ linkwarden_secret_key.stdout }}"
  NEXTAUTH_URL: "{{ lookup('role_var', '_web_url', role='linkwarden') }}/api/v1/auth"
  DATABASE_URL: "postgresql://{{ lookup('role_var', '_postgres_user', role='linkwarden') }}:{{ lookup('role_var', '_postgres_password', role='linkwarden') }}@{{ lookup('role_var', '_postgres_name', role='linkwarden') }}:5432/{{ lookup('role_var', '_postgres_docker_env_db', role='linkwarden') }}"

linkwarden_role_docker_envs_custom

# Type: dict
linkwarden_role_docker_envs_custom: {}

Volumes

linkwarden_role_docker_volumes_default

# Type: list
linkwarden_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='linkwarden') }}:/data/data"

linkwarden_role_docker_volumes_custom

# Type: list
linkwarden_role_docker_volumes_custom: []

Hostname

linkwarden_role_docker_hostname

# Type: string
linkwarden_role_docker_hostname: "{{ linkwarden_name }}"

Networks

linkwarden_role_docker_networks_alias

# Type: string
linkwarden_role_docker_networks_alias: "{{ linkwarden_name }}"

linkwarden_role_docker_networks_default

# Type: list
linkwarden_role_docker_networks_default: []

linkwarden_role_docker_networks_custom

# Type: list
linkwarden_role_docker_networks_custom: []

Restart Policy

linkwarden_role_docker_restart_policy

# Type: string
linkwarden_role_docker_restart_policy: unless-stopped

State

linkwarden_role_docker_state

# Type: string
linkwarden_role_docker_state: started

Dependencies

linkwarden_role_depends_on

# Type: string
linkwarden_role_depends_on: "{{ lookup('role_var', '_postgres_name', role='linkwarden') }}"

linkwarden_role_depends_on_delay

# Type: string (quoted number)
linkwarden_role_depends_on_delay: "0"

linkwarden_role_depends_on_healthchecks

# Type: string ("true"/"false")
linkwarden_role_depends_on_healthchecks: "false"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

linkwarden_role_docker_blkio_weight

# Type: int
linkwarden_role_docker_blkio_weight:

linkwarden_role_docker_cpu_period

# Type: int
linkwarden_role_docker_cpu_period:

linkwarden_role_docker_cpu_quota

# Type: int
linkwarden_role_docker_cpu_quota:

linkwarden_role_docker_cpu_shares

# Type: int
linkwarden_role_docker_cpu_shares:

linkwarden_role_docker_cpus

# Type: string
linkwarden_role_docker_cpus:

linkwarden_role_docker_cpuset_cpus

# Type: string
linkwarden_role_docker_cpuset_cpus:

linkwarden_role_docker_cpuset_mems

# Type: string
linkwarden_role_docker_cpuset_mems:

linkwarden_role_docker_kernel_memory

# Type: string
linkwarden_role_docker_kernel_memory:

linkwarden_role_docker_memory

# Type: string
linkwarden_role_docker_memory:

linkwarden_role_docker_memory_reservation

# Type: string
linkwarden_role_docker_memory_reservation:

linkwarden_role_docker_memory_swap

# Type: string
linkwarden_role_docker_memory_swap:

linkwarden_role_docker_memory_swappiness

# Type: int
linkwarden_role_docker_memory_swappiness:

linkwarden_role_docker_shm_size

# Type: string
linkwarden_role_docker_shm_size:

Security & Devices

linkwarden_role_docker_cap_drop

# Type: list
linkwarden_role_docker_cap_drop:

linkwarden_role_docker_cgroupns_mode

# Type: string
linkwarden_role_docker_cgroupns_mode:

linkwarden_role_docker_device_cgroup_rules

# Type: list
linkwarden_role_docker_device_cgroup_rules:

linkwarden_role_docker_device_read_bps

# Type: list
linkwarden_role_docker_device_read_bps:

linkwarden_role_docker_device_read_iops

# Type: list
linkwarden_role_docker_device_read_iops:

linkwarden_role_docker_device_requests

# Type: list
linkwarden_role_docker_device_requests:

linkwarden_role_docker_device_write_bps

# Type: list
linkwarden_role_docker_device_write_bps:

linkwarden_role_docker_device_write_iops

# Type: list
linkwarden_role_docker_device_write_iops:

linkwarden_role_docker_devices

# Type: list
linkwarden_role_docker_devices:

linkwarden_role_docker_devices_default

# Type: string
linkwarden_role_docker_devices_default:

linkwarden_role_docker_groups

# Type: list
linkwarden_role_docker_groups:

linkwarden_role_docker_privileged

# Type: bool (true/false)
linkwarden_role_docker_privileged:

linkwarden_role_docker_security_opts

# Type: list
linkwarden_role_docker_security_opts:

linkwarden_role_docker_user

# Type: string
linkwarden_role_docker_user:

linkwarden_role_docker_userns_mode

# Type: string
linkwarden_role_docker_userns_mode:

Networking

linkwarden_role_docker_dns_opts

# Type: list
linkwarden_role_docker_dns_opts:

linkwarden_role_docker_dns_search_domains

# Type: list
linkwarden_role_docker_dns_search_domains:

linkwarden_role_docker_dns_servers

# Type: list
linkwarden_role_docker_dns_servers:

linkwarden_role_docker_domainname

# Type: string
linkwarden_role_docker_domainname:

linkwarden_role_docker_exposed_ports

# Type: list
linkwarden_role_docker_exposed_ports:

linkwarden_role_docker_hosts

# Type: dict
linkwarden_role_docker_hosts:

linkwarden_role_docker_hosts_use_common

# Type: bool (true/false)
linkwarden_role_docker_hosts_use_common:

linkwarden_role_docker_ipc_mode

# Type: string
linkwarden_role_docker_ipc_mode:

linkwarden_role_docker_links

# Type: list
linkwarden_role_docker_links:

linkwarden_role_docker_network_mode

# Type: string
linkwarden_role_docker_network_mode:

linkwarden_role_docker_pid_mode

# Type: string
linkwarden_role_docker_pid_mode:

linkwarden_role_docker_ports

# Type: list
linkwarden_role_docker_ports:

linkwarden_role_docker_uts

# Type: string
linkwarden_role_docker_uts:

Storage

linkwarden_role_docker_keep_volumes

# Type: bool (true/false)
linkwarden_role_docker_keep_volumes:

linkwarden_role_docker_mounts

# Type: list
linkwarden_role_docker_mounts:

linkwarden_role_docker_storage_opts

# Type: dict
linkwarden_role_docker_storage_opts:

linkwarden_role_docker_tmpfs

# Type: list
linkwarden_role_docker_tmpfs:

linkwarden_role_docker_volume_driver

# Type: string
linkwarden_role_docker_volume_driver:

linkwarden_role_docker_volumes_from

# Type: list
linkwarden_role_docker_volumes_from:

linkwarden_role_docker_volumes_global

# Type: bool (true/false)
linkwarden_role_docker_volumes_global:

linkwarden_role_docker_working_dir

# Type: string
linkwarden_role_docker_working_dir:

Monitoring & Lifecycle

linkwarden_role_docker_auto_remove

# Type: bool (true/false)
linkwarden_role_docker_auto_remove:

linkwarden_role_docker_cleanup

# Type: bool (true/false)
linkwarden_role_docker_cleanup:

linkwarden_role_docker_force_kill

# Type: string
linkwarden_role_docker_force_kill:

linkwarden_role_docker_healthcheck

# Type: dict
linkwarden_role_docker_healthcheck:

linkwarden_role_docker_healthy_wait_timeout

# Type: int
linkwarden_role_docker_healthy_wait_timeout:

linkwarden_role_docker_init

# Type: bool (true/false)
linkwarden_role_docker_init:

linkwarden_role_docker_kill_signal

# Type: string
linkwarden_role_docker_kill_signal:

linkwarden_role_docker_log_driver

# Type: string
linkwarden_role_docker_log_driver:

linkwarden_role_docker_log_options

# Type: dict
linkwarden_role_docker_log_options:

linkwarden_role_docker_oom_killer

# Type: bool (true/false)
linkwarden_role_docker_oom_killer:

linkwarden_role_docker_oom_score_adj

# Type: int
linkwarden_role_docker_oom_score_adj:

linkwarden_role_docker_output_logs

# Type: bool (true/false)
linkwarden_role_docker_output_logs:

linkwarden_role_docker_paused

# Type: bool (true/false)
linkwarden_role_docker_paused:

linkwarden_role_docker_recreate

# Type: bool (true/false)
linkwarden_role_docker_recreate:

linkwarden_role_docker_restart_retries

# Type: int
linkwarden_role_docker_restart_retries:

linkwarden_role_docker_stop_timeout

# Type: int
linkwarden_role_docker_stop_timeout:

Other Options

linkwarden_role_docker_capabilities

# Type: list
linkwarden_role_docker_capabilities:

linkwarden_role_docker_cgroup_parent

# Type: string
linkwarden_role_docker_cgroup_parent:

linkwarden_role_docker_commands

# Type: list
linkwarden_role_docker_commands:

linkwarden_role_docker_create_timeout

# Type: int
linkwarden_role_docker_create_timeout:

linkwarden_role_docker_entrypoint

# Type: string
linkwarden_role_docker_entrypoint:

linkwarden_role_docker_env_file

# Type: string
linkwarden_role_docker_env_file:

linkwarden_role_docker_labels

# Type: dict
linkwarden_role_docker_labels:

linkwarden_role_docker_labels_use_common

# Type: bool (true/false)
linkwarden_role_docker_labels_use_common:

linkwarden_role_docker_read_only

# Type: bool (true/false)
linkwarden_role_docker_read_only:

linkwarden_role_docker_runtime

# Type: string
linkwarden_role_docker_runtime:

linkwarden_role_docker_sysctls

# Type: list
linkwarden_role_docker_sysctls:

linkwarden_role_docker_ulimits

# Type: list
linkwarden_role_docker_ulimits:

linkwarden_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
linkwarden_role_autoheal_enabled: true

linkwarden_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
linkwarden_role_depends_on: ""

linkwarden_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
linkwarden_role_depends_on_delay: "0"

linkwarden_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
linkwarden_role_depends_on_healthchecks:

linkwarden_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
linkwarden_role_diun_enabled: true

linkwarden_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
linkwarden_role_dns_enabled: true

linkwarden_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
linkwarden_role_docker_controller: true

linkwarden_role_docker_image_repo

# Type: string
linkwarden_role_docker_image_repo:

linkwarden_role_docker_image_tag

# Type: string
linkwarden_role_docker_image_tag:

linkwarden_role_docker_volumes_download

# Type: bool (true/false)
linkwarden_role_docker_volumes_download:

linkwarden_role_paths_location

# Type: string
linkwarden_role_paths_location:

linkwarden_role_postgres_docker_env_db

# Type: string
linkwarden_role_postgres_docker_env_db:

linkwarden_role_postgres_name

# Type: string
linkwarden_role_postgres_name:

linkwarden_role_postgres_password

# Type: string
linkwarden_role_postgres_password:

linkwarden_role_postgres_user

# Type: string
linkwarden_role_postgres_user:

linkwarden_role_themepark_addons

# Type: string
linkwarden_role_themepark_addons:

linkwarden_role_themepark_app

# Type: string
linkwarden_role_themepark_app:

linkwarden_role_themepark_theme

# Type: string
linkwarden_role_themepark_theme:

linkwarden_role_traefik_api_endpoint

# Type: dict/omit
linkwarden_role_traefik_api_endpoint:

linkwarden_role_traefik_api_middleware

# Type: string
linkwarden_role_traefik_api_middleware:

linkwarden_role_traefik_api_middleware_http

# Type: string
linkwarden_role_traefik_api_middleware_http:

linkwarden_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
linkwarden_role_traefik_autodetect_enabled: false

linkwarden_role_traefik_certresolver

# Type: string
linkwarden_role_traefik_certresolver:

linkwarden_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
linkwarden_role_traefik_crowdsec_enabled: false

linkwarden_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
linkwarden_role_traefik_error_pages_enabled: false

linkwarden_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
linkwarden_role_traefik_gzip_enabled: false

linkwarden_role_traefik_middleware_http

# Type: string
linkwarden_role_traefik_middleware_http:

linkwarden_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
linkwarden_role_traefik_middleware_http_api_insecure:

linkwarden_role_traefik_middleware_http_insecure

# Type: bool (true/false)
linkwarden_role_traefik_middleware_http_insecure:

linkwarden_role_traefik_priority

# Type: string
linkwarden_role_traefik_priority:

linkwarden_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
linkwarden_role_traefik_robot_enabled: true

linkwarden_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
linkwarden_role_traefik_tailscale_enabled: false

linkwarden_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
linkwarden_role_traefik_wildcard_enabled: true

linkwarden_role_web_domain

# Type: string
linkwarden_role_web_domain:

linkwarden_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
linkwarden_role_web_fqdn_override:

Example Override

linkwarden_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "linkwarden2.{{ user.domain }}"
  - "linkwarden.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

linkwarden_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
linkwarden_role_web_host_override:

Example Override

linkwarden_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'linkwarden2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

linkwarden_role_web_http_port

# Type: string (quoted number)
linkwarden_role_web_http_port:

linkwarden_role_web_http_scheme

# Type: string ("http"/"https")
linkwarden_role_web_http_scheme:

linkwarden_role_web_http_serverstransport

# Type: dict/omit
linkwarden_role_web_http_serverstransport:

linkwarden_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
linkwarden_role_web_scheme:

linkwarden_role_web_serverstransport

# Type: dict/omit
linkwarden_role_web_serverstransport:

linkwarden_role_web_subdomain

# Type: string
linkwarden_role_web_subdomain:

linkwarden_role_web_url

# Type: string
linkwarden_role_web_url: