Joplin¶

Description / name	Input element
Your domain name

Overview¶

Joplin is an open source note-taking app. Capture your thoughts and securely access them from any device.

Manual

Releases

Community

Deployment¶

sb install sandbox-joplin

Usage¶

Visit https://joplin.iYOUR_DOMAIN_NAMEi.

Basics¶

Info

Default login for joplin is email: admin@localhost password: admin

Change this asap.

Visit here to learn how to use end to end encryption. (Very simple)

Role Defaults¶

Variables can be customized using the Inventory. (1)

Example override
```
joplin_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like joplin_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 joplin_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

joplin_name

# Type: string
joplin_name: joplin

joplin_role_postgres_deploy

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

joplin_role_postgres_name

# Type: string
joplin_role_postgres_name: "{{ joplin_name }}-postgres"

joplin_role_postgres_user

# Type: string
joplin_role_postgres_user: "joplin"

joplin_role_postgres_password

# Type: string
joplin_role_postgres_password: "joplin"

joplin_role_postgres_docker_env_db

# Type: string
joplin_role_postgres_docker_env_db: "joplin"

joplin_role_postgres_docker_image_tag

# Type: string
joplin_role_postgres_docker_image_tag: "13"

joplin_role_postgres_docker_image_repo

# Type: string
joplin_role_postgres_docker_image_repo: "postgres"

joplin_role_postgres_docker_healthcheck

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

joplin_role_postgres_paths_folder

# Type: string
joplin_role_postgres_paths_folder: "{{ joplin_name }}"

joplin_role_postgres_paths_location

# Type: string
joplin_role_postgres_paths_location: "{{ server_appdata_path }}/{{ joplin_role_postgres_paths_folder }}/postgres"

joplin_role_web_subdomain

# Type: string
joplin_role_web_subdomain: "{{ joplin_name }}"

joplin_role_web_domain

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

joplin_role_web_port

# Type: string
joplin_role_web_port: "22300"

joplin_role_web_url

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

joplin_role_dns_record

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

joplin_role_dns_zone

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

joplin_role_dns_proxy

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

joplin_role_traefik_sso_middleware

# Type: string
joplin_role_traefik_sso_middleware: ""

joplin_role_traefik_middleware_default

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

joplin_role_traefik_middleware_custom

# Type: string
joplin_role_traefik_middleware_custom: ""

joplin_role_traefik_certresolver

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

joplin_role_traefik_enabled

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

joplin_role_traefik_api_enabled

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

joplin_role_traefik_api_endpoint

# Type: string
joplin_role_traefik_api_endpoint: ""

Container

joplin_role_docker_container

# Type: string
joplin_role_docker_container: "{{ joplin_name }}"

Image

joplin_role_docker_image_pull

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

joplin_role_docker_image_repo

# Type: string
joplin_role_docker_image_repo: "joplin/server"

joplin_role_docker_image_tag

# Type: string
joplin_role_docker_image_tag: "latest"

joplin_role_docker_image

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

Envs

joplin_role_docker_envs_default

# Type: dict
joplin_role_docker_envs_default:
  TZ: "{{ tz }}"
  APP_BASE_URL: "{{ lookup('role_var', '_web_url', role='joplin') }}"
  APP_PORT: "22300"
  POSTGRES_PASSWORD: "{{ lookup('role_var', '_postgres_password', role='joplin') }}"
  POSTGRES_DATABASE: "{{ lookup('role_var', '_postgres_docker_env_db', role='joplin') }}"
  POSTGRES_USER: "{{ lookup('role_var', '_postgres_user', role='joplin') }}"
  POSTGRES_PORT: "5432"
  POSTGRES_HOST: "{{ lookup('role_var', '_postgres_name', role='joplin') }}"
  DB_CLIENT: "pg"

joplin_role_docker_envs_custom

# Type: dict
joplin_role_docker_envs_custom: {}

Hostname

joplin_role_docker_hostname

# Type: string
joplin_role_docker_hostname: "{{ joplin_name }}"

Networks

joplin_role_docker_networks_alias

# Type: string
joplin_role_docker_networks_alias: "{{ joplin_name }}"

joplin_role_docker_networks_default

# Type: list
joplin_role_docker_networks_default: []

joplin_role_docker_networks_custom

# Type: list
joplin_role_docker_networks_custom: []

Restart Policy

joplin_role_docker_restart_policy

# Type: string
joplin_role_docker_restart_policy: unless-stopped

State

joplin_role_docker_state

# Type: string
joplin_role_docker_state: started

Dependencies

joplin_role_depends_on

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

joplin_role_depends_on_delay

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

joplin_role_depends_on_healthchecks

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

Create Docker Container Timeout

joplin_docker_create_timeout

# Type: int
joplin_docker_create_timeout: 300

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

Resource Limits

joplin_role_docker_blkio_weight

# Type: int
joplin_role_docker_blkio_weight:

joplin_role_docker_cpu_period

# Type: int
joplin_role_docker_cpu_period:

joplin_role_docker_cpu_quota

# Type: int
joplin_role_docker_cpu_quota:

joplin_role_docker_cpu_shares

# Type: int
joplin_role_docker_cpu_shares:

joplin_role_docker_cpus

# Type: string
joplin_role_docker_cpus:

joplin_role_docker_cpuset_cpus

# Type: string
joplin_role_docker_cpuset_cpus:

joplin_role_docker_cpuset_mems

# Type: string
joplin_role_docker_cpuset_mems:

joplin_role_docker_kernel_memory

# Type: string
joplin_role_docker_kernel_memory:

joplin_role_docker_memory

# Type: string
joplin_role_docker_memory:

joplin_role_docker_memory_reservation

# Type: string
joplin_role_docker_memory_reservation:

joplin_role_docker_memory_swap

# Type: string
joplin_role_docker_memory_swap:

joplin_role_docker_memory_swappiness

# Type: int
joplin_role_docker_memory_swappiness:

joplin_role_docker_shm_size

# Type: string
joplin_role_docker_shm_size:

Security & Devices

joplin_role_docker_cap_drop

# Type: list
joplin_role_docker_cap_drop:

joplin_role_docker_cgroupns_mode

# Type: string
joplin_role_docker_cgroupns_mode:

joplin_role_docker_device_cgroup_rules

# Type: list
joplin_role_docker_device_cgroup_rules:

joplin_role_docker_device_read_bps

# Type: list
joplin_role_docker_device_read_bps:

joplin_role_docker_device_read_iops

# Type: list
joplin_role_docker_device_read_iops:

joplin_role_docker_device_requests

# Type: list
joplin_role_docker_device_requests:

joplin_role_docker_device_write_bps

# Type: list
joplin_role_docker_device_write_bps:

joplin_role_docker_device_write_iops

# Type: list
joplin_role_docker_device_write_iops:

joplin_role_docker_devices

# Type: list
joplin_role_docker_devices:

joplin_role_docker_devices_default

# Type: string
joplin_role_docker_devices_default:

joplin_role_docker_groups

# Type: list
joplin_role_docker_groups:

joplin_role_docker_privileged

# Type: bool (true/false)
joplin_role_docker_privileged:

joplin_role_docker_security_opts

# Type: list
joplin_role_docker_security_opts:

joplin_role_docker_user

# Type: string
joplin_role_docker_user:

joplin_role_docker_userns_mode

# Type: string
joplin_role_docker_userns_mode:

Networking

joplin_role_docker_dns_opts

# Type: list
joplin_role_docker_dns_opts:

joplin_role_docker_dns_search_domains

# Type: list
joplin_role_docker_dns_search_domains:

joplin_role_docker_dns_servers

# Type: list
joplin_role_docker_dns_servers:

joplin_role_docker_domainname

# Type: string
joplin_role_docker_domainname:

joplin_role_docker_exposed_ports

# Type: list
joplin_role_docker_exposed_ports:

joplin_role_docker_hosts

# Type: dict
joplin_role_docker_hosts:

joplin_role_docker_hosts_use_common

# Type: bool (true/false)
joplin_role_docker_hosts_use_common:

joplin_role_docker_ipc_mode

# Type: string
joplin_role_docker_ipc_mode:

joplin_role_docker_links

# Type: list
joplin_role_docker_links:

joplin_role_docker_network_mode

# Type: string
joplin_role_docker_network_mode:

joplin_role_docker_pid_mode

# Type: string
joplin_role_docker_pid_mode:

joplin_role_docker_ports

# Type: list
joplin_role_docker_ports:

joplin_role_docker_uts

# Type: string
joplin_role_docker_uts:

Storage

joplin_role_docker_keep_volumes

# Type: bool (true/false)
joplin_role_docker_keep_volumes:

joplin_role_docker_mounts

# Type: list
joplin_role_docker_mounts:

joplin_role_docker_storage_opts

# Type: dict
joplin_role_docker_storage_opts:

joplin_role_docker_tmpfs

# Type: list
joplin_role_docker_tmpfs:

joplin_role_docker_volume_driver

# Type: string
joplin_role_docker_volume_driver:

joplin_role_docker_volumes

# Type: list
joplin_role_docker_volumes:

joplin_role_docker_volumes_from

# Type: list
joplin_role_docker_volumes_from:

joplin_role_docker_volumes_global

# Type: bool (true/false)
joplin_role_docker_volumes_global:

joplin_role_docker_working_dir

# Type: string
joplin_role_docker_working_dir:

Monitoring & Lifecycle

joplin_role_docker_auto_remove

# Type: bool (true/false)
joplin_role_docker_auto_remove:

joplin_role_docker_cleanup

# Type: bool (true/false)
joplin_role_docker_cleanup:

joplin_role_docker_force_kill

# Type: string
joplin_role_docker_force_kill:

joplin_role_docker_healthcheck

# Type: dict
joplin_role_docker_healthcheck:

joplin_role_docker_healthy_wait_timeout

# Type: int
joplin_role_docker_healthy_wait_timeout:

joplin_role_docker_init

# Type: bool (true/false)
joplin_role_docker_init:

joplin_role_docker_kill_signal

# Type: string
joplin_role_docker_kill_signal:

joplin_role_docker_log_driver

# Type: string
joplin_role_docker_log_driver:

joplin_role_docker_log_options

# Type: dict
joplin_role_docker_log_options:

joplin_role_docker_oom_killer

# Type: bool (true/false)
joplin_role_docker_oom_killer:

joplin_role_docker_oom_score_adj

# Type: int
joplin_role_docker_oom_score_adj:

joplin_role_docker_output_logs

# Type: bool (true/false)
joplin_role_docker_output_logs:

joplin_role_docker_paused

# Type: bool (true/false)
joplin_role_docker_paused:

joplin_role_docker_recreate

# Type: bool (true/false)
joplin_role_docker_recreate:

joplin_role_docker_restart_retries

# Type: int
joplin_role_docker_restart_retries:

joplin_role_docker_stop_timeout

# Type: int
joplin_role_docker_stop_timeout:

Other Options

joplin_role_docker_capabilities

# Type: list
joplin_role_docker_capabilities:

joplin_role_docker_cgroup_parent

# Type: string
joplin_role_docker_cgroup_parent:

joplin_role_docker_commands

# Type: list
joplin_role_docker_commands:

joplin_role_docker_create_timeout

# Type: int
joplin_role_docker_create_timeout:

joplin_role_docker_entrypoint

# Type: string
joplin_role_docker_entrypoint:

joplin_role_docker_env_file

# Type: string
joplin_role_docker_env_file:

joplin_role_docker_labels

# Type: dict
joplin_role_docker_labels:

joplin_role_docker_labels_use_common

# Type: bool (true/false)
joplin_role_docker_labels_use_common:

joplin_role_docker_read_only

# Type: bool (true/false)
joplin_role_docker_read_only:

joplin_role_docker_runtime

# Type: string
joplin_role_docker_runtime:

joplin_role_docker_sysctls

# Type: list
joplin_role_docker_sysctls:

joplin_role_docker_ulimits

# Type: list
joplin_role_docker_ulimits:

joplin_role_autoheal_enabled

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

joplin_role_diun_enabled

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

joplin_role_dns_enabled

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

joplin_role_docker_controller

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

joplin_role_docker_networks_alias_custom

# Type: list
joplin_role_docker_networks_alias_custom:

joplin_role_docker_volumes_download

# Type: bool (true/false)
joplin_role_docker_volumes_download:

joplin_role_themepark_addons

# Type: string
joplin_role_themepark_addons:

joplin_role_themepark_app

# Type: string
joplin_role_themepark_app:

joplin_role_themepark_theme

# Type: string
joplin_role_themepark_theme:

joplin_role_traefik_api_middleware

# Type: string
joplin_role_traefik_api_middleware:

joplin_role_traefik_api_middleware_http

# Type: string
joplin_role_traefik_api_middleware_http:

joplin_role_traefik_autodetect_enabled

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

joplin_role_traefik_crowdsec_enabled

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

joplin_role_traefik_error_pages_enabled

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

joplin_role_traefik_gzip_enabled

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

joplin_role_traefik_middleware_http

# Type: string
joplin_role_traefik_middleware_http:

joplin_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
joplin_role_traefik_middleware_http_api_insecure:

joplin_role_traefik_middleware_http_insecure

# Type: bool (true/false)
joplin_role_traefik_middleware_http_insecure:

joplin_role_traefik_priority

# Type: string
joplin_role_traefik_priority:

joplin_role_traefik_robot_enabled

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

joplin_role_traefik_tailscale_enabled

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

joplin_role_traefik_wildcard_enabled

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

joplin_role_web_api_http_port

# Type: string (quoted number)
joplin_role_web_api_http_port:

joplin_role_web_api_http_scheme

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

joplin_role_web_api_http_serverstransport

# Type: dict/omit
joplin_role_web_api_http_serverstransport:

joplin_role_web_api_port

# Type: string (quoted number)
joplin_role_web_api_port:

joplin_role_web_api_scheme

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

joplin_role_web_api_serverstransport

# Type: dict/omit
joplin_role_web_api_serverstransport:

joplin_role_web_fqdn_override

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

Example Override

joplin_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "joplin2.{{ user.domain }}"
  - "joplin.otherdomain.tld"

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

joplin_role_web_host_override

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

Example Override

joplin_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'joplin2.' + user.domain }}`)"

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

joplin_role_web_http_port

# Type: string (quoted number)
joplin_role_web_http_port:

joplin_role_web_http_scheme

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

joplin_role_web_http_serverstransport

# Type: dict/omit
joplin_role_web_http_serverstransport:

joplin_role_web_scheme

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

joplin_role_web_serverstransport

# Type: dict/omit
joplin_role_web_serverstransport: