Membarr¶

Overview¶

Membarr is a fork of Invitarr that invites discord users to Plex and Jellyfin. You can also automate this bot to invite discord users to a media server once a certain role is given to a user or the user can also be added manually.

Manual

Releases

Community

Deployment¶

sb install sandbox-membarr

Usage¶

Basics¶

Create Discord bot¶

Create the Discord server that your users will get member roles or use an existing discord that you can assign roles from.
Log into the Discord Developer Portal and click 'New Application'
Add a short description and an icon for the bot. Save changes. (Optional)
Go to Bot section in the side menu.
Uncheck 'Public Bot' under Authorization Flow
Check all 3 boxes under Privileged Gateway Intents: Presence Intent, Server Members Intent, and Message Content Intent. Save changes.
Copy the token under the username or reset it to copy. This is the token used in the docker image.
Go to OAuth2 section in the side menu, then click URL Generator.
Under Scopes, check bot and applications.commands.
Copy the Generated URL and paste into your browser and add it to your discord server from Step 1.
The bot will come online after the docker container is running with the correct Bot Token.

Set up Plex parameters¶

When you install the role, it will create 2 files, an app.db file and config.ini. You will need to edit the config.ini file with your preferred editing program. (ie nano or vim etc) Add your Plex credentials like so:

[bot_envs]
plex_user =
plex_pass =
plex_server_name = ServerFriendlyName
plex_roles =
plex_token = token
plex_base_url = https://plex.xYOUR_DOMAIN_NAME_1768207599_9920_EDITABLEx
plex_enabled = True

Now restart the Membarr container docker restart membarr.

Plex Token

To get the Plex token, you will run the following command: sb install plex-auth-token Look for the Display Plex Auth Token task in the log.

Role Defaults¶

Use the Inventory to customize variables. (1)

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

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

BasicsDockerDocker+Global Override Options

membarr_name

# Type: string
membarr_name: membarr

Container

membarr_role_docker_container

# Type: string
membarr_role_docker_container: "{{ membarr_name }}"

Image

membarr_role_docker_image_pull

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

membarr_role_docker_image_tag

# Type: string
membarr_role_docker_image_tag: "latest"

membarr_role_docker_image_repo

# Type: string
membarr_role_docker_image_repo: "yoruio/membarr"

membarr_role_docker_image

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

Envs

membarr_role_docker_envs_default

# Type: dict
membarr_role_docker_envs_default:
  TZ: "{{ tz }}"
  token: "{{ membarr.discord_token }}"

membarr_role_docker_envs_custom

# Type: dict
membarr_role_docker_envs_custom: {}

Volumes

membarr_role_docker_volumes_default

# Type: list
membarr_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='membarr') }}:/app/app/config"

membarr_role_docker_volumes_custom

# Type: list
membarr_role_docker_volumes_custom: []

Hostname

membarr_role_docker_hostname

# Type: string
membarr_role_docker_hostname: "{{ membarr_name }}"

Networks

membarr_role_docker_networks_alias

# Type: string
membarr_role_docker_networks_alias: "{{ membarr_name }}"

membarr_role_docker_networks_default

# Type: list
membarr_role_docker_networks_default: []

membarr_role_docker_networks_custom

# Type: list
membarr_role_docker_networks_custom: []

Restart Policy

membarr_role_docker_restart_policy

# Type: string
membarr_role_docker_restart_policy: unless-stopped

State

membarr_role_docker_state

# Type: string
membarr_role_docker_state: started

User

membarr_role_docker_user

# Type: string
membarr_role_docker_user: "{{ uid }}:{{ gid }}"

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

Resource Limits

membarr_role_docker_blkio_weight

# Type: int
membarr_role_docker_blkio_weight:

membarr_role_docker_cpu_period

# Type: int
membarr_role_docker_cpu_period:

membarr_role_docker_cpu_quota

# Type: int
membarr_role_docker_cpu_quota:

membarr_role_docker_cpu_shares

# Type: int
membarr_role_docker_cpu_shares:

membarr_role_docker_cpus

# Type: string
membarr_role_docker_cpus:

membarr_role_docker_cpuset_cpus

# Type: string
membarr_role_docker_cpuset_cpus:

membarr_role_docker_cpuset_mems

# Type: string
membarr_role_docker_cpuset_mems:

membarr_role_docker_kernel_memory

# Type: string
membarr_role_docker_kernel_memory:

membarr_role_docker_memory

# Type: string
membarr_role_docker_memory:

membarr_role_docker_memory_reservation

# Type: string
membarr_role_docker_memory_reservation:

membarr_role_docker_memory_swap

# Type: string
membarr_role_docker_memory_swap:

membarr_role_docker_memory_swappiness

# Type: int
membarr_role_docker_memory_swappiness:

membarr_role_docker_shm_size

# Type: string
membarr_role_docker_shm_size:

Security & Devices

membarr_role_docker_cap_drop

# Type: list
membarr_role_docker_cap_drop:

membarr_role_docker_cgroupns_mode

# Type: string
membarr_role_docker_cgroupns_mode:

membarr_role_docker_device_cgroup_rules

# Type: list
membarr_role_docker_device_cgroup_rules:

membarr_role_docker_device_read_bps

# Type: list
membarr_role_docker_device_read_bps:

membarr_role_docker_device_read_iops

# Type: list
membarr_role_docker_device_read_iops:

membarr_role_docker_device_requests

# Type: list
membarr_role_docker_device_requests:

membarr_role_docker_device_write_bps

# Type: list
membarr_role_docker_device_write_bps:

membarr_role_docker_device_write_iops

# Type: list
membarr_role_docker_device_write_iops:

membarr_role_docker_devices

# Type: list
membarr_role_docker_devices:

membarr_role_docker_devices_default

# Type: string
membarr_role_docker_devices_default:

membarr_role_docker_groups

# Type: list
membarr_role_docker_groups:

membarr_role_docker_privileged

# Type: bool (true/false)
membarr_role_docker_privileged:

membarr_role_docker_security_opts

# Type: list
membarr_role_docker_security_opts:

membarr_role_docker_userns_mode

# Type: string
membarr_role_docker_userns_mode:

Networking

membarr_role_docker_dns_opts

# Type: list
membarr_role_docker_dns_opts:

membarr_role_docker_dns_search_domains

# Type: list
membarr_role_docker_dns_search_domains:

membarr_role_docker_dns_servers

# Type: list
membarr_role_docker_dns_servers:

membarr_role_docker_domainname

# Type: string
membarr_role_docker_domainname:

membarr_role_docker_exposed_ports

# Type: list
membarr_role_docker_exposed_ports:

membarr_role_docker_hosts

# Type: dict
membarr_role_docker_hosts:

membarr_role_docker_hosts_use_common

# Type: bool (true/false)
membarr_role_docker_hosts_use_common:

membarr_role_docker_ipc_mode

# Type: string
membarr_role_docker_ipc_mode:

membarr_role_docker_links

# Type: list
membarr_role_docker_links:

membarr_role_docker_network_mode

# Type: string
membarr_role_docker_network_mode:

membarr_role_docker_pid_mode

# Type: string
membarr_role_docker_pid_mode:

membarr_role_docker_ports

# Type: list
membarr_role_docker_ports:

membarr_role_docker_uts

# Type: string
membarr_role_docker_uts:

Storage

membarr_role_docker_keep_volumes

# Type: bool (true/false)
membarr_role_docker_keep_volumes:

membarr_role_docker_mounts

# Type: list
membarr_role_docker_mounts:

membarr_role_docker_storage_opts

# Type: dict
membarr_role_docker_storage_opts:

membarr_role_docker_tmpfs

# Type: list
membarr_role_docker_tmpfs:

membarr_role_docker_volume_driver

# Type: string
membarr_role_docker_volume_driver:

membarr_role_docker_volumes_from

# Type: list
membarr_role_docker_volumes_from:

membarr_role_docker_volumes_global

# Type: bool (true/false)
membarr_role_docker_volumes_global:

membarr_role_docker_working_dir

# Type: string
membarr_role_docker_working_dir:

Monitoring & Lifecycle

membarr_role_docker_auto_remove

# Type: bool (true/false)
membarr_role_docker_auto_remove:

membarr_role_docker_cleanup

# Type: bool (true/false)
membarr_role_docker_cleanup:

membarr_role_docker_force_kill

# Type: string
membarr_role_docker_force_kill:

membarr_role_docker_healthcheck

# Type: dict
membarr_role_docker_healthcheck:

membarr_role_docker_healthy_wait_timeout

# Type: int
membarr_role_docker_healthy_wait_timeout:

membarr_role_docker_init

# Type: bool (true/false)
membarr_role_docker_init:

membarr_role_docker_kill_signal

# Type: string
membarr_role_docker_kill_signal:

membarr_role_docker_log_driver

# Type: string
membarr_role_docker_log_driver:

membarr_role_docker_log_options

# Type: dict
membarr_role_docker_log_options:

membarr_role_docker_oom_killer

# Type: bool (true/false)
membarr_role_docker_oom_killer:

membarr_role_docker_oom_score_adj

# Type: int
membarr_role_docker_oom_score_adj:

membarr_role_docker_output_logs

# Type: bool (true/false)
membarr_role_docker_output_logs:

membarr_role_docker_paused

# Type: bool (true/false)
membarr_role_docker_paused:

membarr_role_docker_recreate

# Type: bool (true/false)
membarr_role_docker_recreate:

membarr_role_docker_restart_retries

# Type: int
membarr_role_docker_restart_retries:

membarr_role_docker_stop_timeout

# Type: int
membarr_role_docker_stop_timeout:

Other Options

membarr_role_docker_capabilities

# Type: list
membarr_role_docker_capabilities:

membarr_role_docker_cgroup_parent

# Type: string
membarr_role_docker_cgroup_parent:

membarr_role_docker_commands

# Type: list
membarr_role_docker_commands:

membarr_role_docker_create_timeout

# Type: int
membarr_role_docker_create_timeout:

membarr_role_docker_entrypoint

# Type: string
membarr_role_docker_entrypoint:

membarr_role_docker_env_file

# Type: string
membarr_role_docker_env_file:

membarr_role_docker_labels

# Type: dict
membarr_role_docker_labels:

membarr_role_docker_labels_use_common

# Type: bool (true/false)
membarr_role_docker_labels_use_common:

membarr_role_docker_read_only

# Type: bool (true/false)
membarr_role_docker_read_only:

membarr_role_docker_runtime

# Type: string
membarr_role_docker_runtime:

membarr_role_docker_sysctls

# Type: list
membarr_role_docker_sysctls:

membarr_role_docker_ulimits

# Type: list
membarr_role_docker_ulimits:

membarr_role_autoheal_enabled

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

membarr_role_depends_on

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

membarr_role_depends_on_delay

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

membarr_role_depends_on_healthchecks

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

membarr_role_diun_enabled

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

membarr_role_docker_controller

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

membarr_role_docker_image_repo

# Type: string
membarr_role_docker_image_repo:

membarr_role_docker_image_tag

# Type: string
membarr_role_docker_image_tag:

membarr_role_docker_volumes_download

# Type: bool (true/false)
membarr_role_docker_volumes_download:

membarr_role_paths_location

# Type: string
membarr_role_paths_location: