Ebbwell
Get Started with Apps!
Keywords: health, period, cycle, fertility, privacy
Train: Community
Home Page: https://github.com/Maxren2/ebbwell
Added: 2026-10-02
Last Updated: 2026-10-02
Private, self-hosted period tracker and ovulation estimator with symptothermal rules, reminders, app lock, partner sharing, single sign-on and local accounts.
Run as Context- Container [ebbwell] can run as any non-root user and group.
Group: 568 / Host group is [apps]
User: 568 / Host user is [apps]
App Metadata (Raw File)
{
"1.0.0": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/ebbwell/1.0.0",
"last_update": "2026-10-02 19:03:03",
"required_features": [],
"human_version": "0.7.1_1.0.0",
"version": "1.0.0",
"app_metadata": {
"app_version": "0.7.1",
"capabilities": [],
"categories": [
"health"
],
"changelog_url": "https://github.com/Maxren2/ebbwell/releases",
"date_added": "2026-10-02",
"description": "Private, self-hosted period tracker and ovulation estimator with symptothermal rules, reminders, app lock, partner sharing, single sign-on and local accounts.",
"home": "https://github.com/Maxren2/ebbwell",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/ebbwell/icons/icon.png",
"keywords": [
"health",
"period",
"cycle",
"fertility",
"privacy"
],
"lib_version": "2.3.15",
"lib_version_hash": "418b1697e018a564438ced4d735f4ced3ea16cc9fa74971a6040e769c80a66e5",
"maintainers": [
{
"email": "dev@truenas.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "ebbwell",
"run_as_context": [
{
"description": "Container [ebbwell] can run as any non-root user and group.",
"gid": 568,
"group_name": "Host group is [apps]",
"uid": 568,
"user_name": "Host user is [apps]"
}
],
"screenshots": [],
"sources": [
"https://apps.truenas.com/catalog/ebbwell_community/",
"https://github.com/Maxren2/ebbwell",
"https://github.com/Maxren2/ebbwell/pkgs/container/ebbwell"
],
"title": "Ebbwell",
"train": "community",
"version": "1.0.0"
},
"schema": {
"groups": [
{
"name": "Ebbwell Configuration",
"description": "Configure Ebbwell"
},
{
"name": "User and Group Configuration",
"description": "Configure User and Group for Ebbwell"
},
{
"name": "Network Configuration",
"description": "Configure Network for Ebbwell"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for Ebbwell"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for Ebbwell"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for Ebbwell"
}
],
"questions": [
{
"variable": "ebbwell",
"label": "",
"group": "Ebbwell Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "app_url",
"label": "Public URL",
"description": "The address users open. With a reverse proxy, its HTTPS address (for example https://ebbwell.example.com):</br>\npasswords are then never accepted through that domain when sign-in is limited to the local network.</br>\nFor a LAN-only install without a domain, the NAS address (for example http://192.168.1.10:30000).\n",
"schema": {
"type": "uri",
"default": "",
"required": true
}
},
{
"variable": "data_encryption_key",
"label": "Data Encryption Key",
"description": "Encrypts all health data at rest. 32 random bytes, base64-encoded (create with: openssl rand -base64 32).</br>\nKeep a copy somewhere safe: without it the data and backups cannot be decrypted.\n",
"schema": {
"type": "string",
"default": "",
"required": true,
"private": true,
"min_length": 44,
"max_length": 44
}
},
{
"variable": "local_login",
"label": "Password Sign-in (Local Accounts)",
"description": "Where local accounts (username + password) may sign in.</br>\n- Disabled: Only single sign-on is available.</br>\n- Local Network: Sign-in from your LAN by the NAS address, never through the public domain (recommended).</br>\n- Everywhere: Sign-in also through the public domain from the internet (not recommended).\n",
"schema": {
"type": "string",
"default": "local-network",
"required": true,
"enum": [
{
"value": "disabled",
"description": "Disabled"
},
{
"value": "local-network",
"description": "Local Network"
},
{
"value": "everywhere",
"description": "Everywhere"
}
]
}
},
{
"variable": "local_2fa",
"label": "Two-Factor Authentication (Local Accounts)",
"description": "Authenticator-app codes for local accounts. Required forces every local user to set it up at next sign-in.",
"schema": {
"type": "string",
"show_if": [
[
"local_login",
"!=",
"disabled"
]
],
"default": "optional",
"required": true,
"enum": [
{
"value": "optional",
"description": "Optional (users choose)"
},
{
"value": "required",
"description": "Required for every local account"
}
]
}
},
{
"variable": "local_networks",
"label": "Local Networks",
"description": "Networks (CIDR) considered local, in addition to loopback (127.0.0.0/8, ::1/128), which always is.",
"schema": {
"type": "list",
"show_if": [
[
"local_login",
"=",
"local-network"
]
],
"default": [
"10.0.0.0/8",
"172.16.0.0/12",
"192.168.0.0/16",
"169.254.0.0/16",
"fc00::/7",
"fe80::/10"
],
"items": [
{
"variable": "network",
"label": "Network",
"schema": {
"type": "string",
"default": "",
"required": true
}
}
]
}
},
{
"variable": "admin_username",
"label": "Administrator Username",
"description": "Local administrator, created at startup if it doesn't exist yet. It creates the other local accounts.",
"schema": {
"type": "string",
"show_if": [
[
"local_login",
"!=",
"disabled"
]
],
"default": "admin",
"required": true,
"valid_chars": "^[a-z0-9][a-z0-9._-]{2,31}$",
"valid_chars_error": "3 to 32 lowercase letters, digits, dot, dash or underscore."
}
},
{
"variable": "admin_password",
"label": "Administrator Password",
"description": "Initial password of that administrator, used only when the account is created.",
"schema": {
"type": "string",
"show_if": [
[
"local_login",
"!=",
"disabled"
]
],
"default": "",
"required": true,
"private": true,
"min_length": 10,
"max_length": 128
}
},
{
"variable": "trust_proxy",
"label": "Trusted Proxies",
"description": "Addresses of your reverse proxy (IPs, CIDRs or loopback / linklocal / uniquelocal), used to see real client IPs.",
"schema": {
"type": "list",
"required": true,
"default": [
"loopback",
"uniquelocal"
],
"items": [
{
"variable": "proxy",
"label": "Proxy",
"schema": {
"type": "string",
"default": "",
"required": true
}
}
]
}
},
{
"variable": "backup_retention_days",
"label": "Backup Retention (Days)",
"description": "Daily encrypted database backups are kept in the data storage for this many days. 0 disables them.",
"schema": {
"type": "int",
"default": 14,
"min": 0,
"max": 365,
"required": true
}
},
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"description": "Configure additional environment variables for Ebbwell.</br>\nSingle sign-on (OpenID Connect) is set up here: OIDC_ISSUER, OIDC_CLIENT_ID, OIDC_CLIENT_SECRET, ...\n",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "env",
"label": "Environment Variable",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Name",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string"
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "run_as",
"label": "",
"group": "User and Group Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "user",
"label": "User ID",
"description": "The user id that Ebbwell files will be owned by.",
"schema": {
"type": "int",
"min": 568,
"default": 568,
"required": true
}
},
{
"variable": "group",
"label": "Group ID",
"description": "The group id that Ebbwell files will be owned by.",
"schema": {
"type": "int",
"min": 568,
"default": 568,
"required": true
}
}
]
}
},
{
"variable": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "web_port",
"label": "WebUI Port",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "bind_mode",
"label": "Port Bind Mode",
"description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
"schema": {
"type": "string",
"default": "published",
"enum": [
{
"value": "published",
"description": "Publish port on the host for external access"
},
{
"value": "exposed",
"description": "Expose port for inter-container communication"
},
{
"value": "",
"description": "None"
}
]
}
},
{
"variable": "port_number",
"label": "Port Number",
"schema": {
"type": "int",
"default": 30000,
"min": 1,
"max": 65535,
"required": true
}
},
{
"variable": "host_ips",
"label": "Host IPs",
"description": "IPs on the host to bind this port",
"schema": {
"type": "list",
"show_if": [
[
"bind_mode",
"=",
"published"
]
],
"default": [],
"items": [
{
"variable": "host_ip",
"label": "Host IP",
"schema": {
"type": "string",
"required": true,
"$ref": [
"definitions/node_bind_ip"
]
}
}
]
}
}
]
}
},
{
"variable": "networks",
"label": "Networks",
"description": "The docker networks to join",
"schema": {
"type": "list",
"show_if": [
[
"host_network",
"=",
false
]
],
"default": [],
"items": [
{
"variable": "network",
"label": "Network",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Name",
"description": "The name of the network to join.</br>\nThe network must already exist.\n",
"schema": {
"type": "string",
"default": "",
"required": true
}
},
{
"variable": "containers",
"label": "Containers",
"description": "The containers to add to this network.",
"schema": {
"type": "list",
"items": [
{
"variable": "container",
"label": "Container",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Container Name",
"schema": {
"type": "string",
"required": true,
"enum": [
{
"value": "ebbwell",
"description": "ebbwell"
}
]
}
},
{
"variable": "config",
"label": "Container Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "aliases",
"label": "Aliases (Optional)",
"description": "The network aliases to use for this container on this network.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "alias",
"label": "Alias",
"schema": {
"type": "string"
}
}
]
}
},
{
"variable": "interface_name",
"label": "Interface Name (Optional)",
"description": "The network interface name to use for this network",
"schema": {
"type": "string"
}
},
{
"variable": "mac_address",
"label": "MAC Address (Optional)",
"description": "The MAC address to use for this network interface.",
"schema": {
"type": "string"
}
},
{
"variable": "ipv4_address",
"label": "IPv4 Address (Optional)",
"description": "The IPv4 address to use for this network interface.",
"schema": {
"type": "string"
}
},
{
"variable": "ipv6_address",
"label": "IPv6 Address (Optional)",
"description": "The IPv6 address to use for this network interface.",
"schema": {
"type": "string"
}
},
{
"variable": "gw_priority",
"label": "Gateway Priority (Optional)",
"description": "Indicates the priority of the gateway for this network interface.",
"schema": {
"type": "int",
"null": true
}
},
{
"variable": "priority",
"label": "Priority (Optional)",
"description": "Indicates in which order Compose connects the service's containers to its networks.",
"schema": {
"type": "int",
"null": true
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "host_network",
"label": "Host Network",
"description": "Bind to the host network. It's recommended to keep this disabled.\n",
"schema": {
"type": "boolean",
"default": false
}
}
]
}
},
{
"variable": "storage",
"label": "",
"group": "Storage Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "data",
"label": "Ebbwell Data Storage",
"description": "The path to store Ebbwell Data.",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"hidden": true,
"default": "data"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": []
}
}
]
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
}
]
}
},
{
"variable": "additional_storage",
"label": "Additional Storage",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "storageEntry",
"label": "Storage Entry",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.</br>\nNFS Share: Is a NFS share that is mounted to as a volume.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
},
{
"value": "cifs",
"description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
},
{
"value": "nfs",
"description": "NFS Share (Mounts a volume to a NFS share)"
}
]
}
},
{
"variable": "read_only",
"label": "Read Only",
"description": "Mount the volume as read only.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "mount_path",
"label": "Mount Path",
"description": "The path inside the container to mount the storage.",
"schema": {
"type": "path",
"required": true
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"default": "storage_entry"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": []
}
}
]
}
},
{
"variable": "cifs_config",
"label": "SMB Configuration",
"description": "The configuration for the SMB dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"cifs"
]
],
"attrs": [
{
"variable": "server",
"label": "Server",
"description": "The server to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "path",
"label": "Path",
"description": "The path to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "username",
"label": "Username",
"description": "The username to use for the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "password",
"label": "Password",
"description": "The password to use for the SMB share.",
"schema": {
"type": "string",
"required": true,
"private": true
}
},
{
"variable": "domain",
"label": "Domain",
"description": "The domain to use for the SMB share.",
"schema": {
"type": "string"
}
}
]
}
},
{
"variable": "nfs_config",
"label": "NFS Configuration",
"description": "The configuration for the NFS dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"nfs"
]
],
"attrs": [
{
"variable": "server",
"label": "Server",
"description": "The server to mount the NFS share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "path",
"label": "Path",
"description": "The path to mount the NFS share.",
"schema": {
"type": "string",
"required": true
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "labels",
"label": "",
"group": "Labels Configuration",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "label",
"label": "Label",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "key",
"label": "Key",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "containers",
"label": "Containers",
"description": "Containers where the label should be applied",
"schema": {
"type": "list",
"items": [
{
"variable": "container",
"label": "Container",
"schema": {
"type": "string",
"required": true,
"enum": [
{
"value": "ebbwell",
"description": "ebbwell"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "resources",
"label": "",
"group": "Resources Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "limits",
"label": "Limits",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "cpus",
"label": "CPUs",
"description": "CPUs limit for Ebbwell.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Ebbwell.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>Ebbwell</h1> <p><a href=\"https://github.com/Maxren2/ebbwell\">Ebbwell</a> is a private, self-hosted period tracker and ovulation estimator.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "0.7.1",
"capabilities": [],
"categories": [
"health"
],
"changelog_url": "https://github.com/Maxren2/ebbwell/releases",
"date_added": "2026-10-02",
"description": "Private, self-hosted period tracker and ovulation estimator with symptothermal rules, reminders, app lock, partner sharing, single sign-on and local accounts.",
"home": "https://github.com/Maxren2/ebbwell",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/ebbwell/icons/icon.png",
"keywords": [
"health",
"period",
"cycle",
"fertility",
"privacy"
],
"lib_version": "2.3.15",
"lib_version_hash": "418b1697e018a564438ced4d735f4ced3ea16cc9fa74971a6040e769c80a66e5",
"maintainers": [
{
"email": "dev@truenas.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "ebbwell",
"run_as_context": [
{
"description": "Container [ebbwell] can run as any non-root user and group.",
"gid": 568,
"group_name": "Host group is [apps]",
"uid": 568,
"user_name": "Host user is [apps]"
}
],
"screenshots": [],
"sources": [
"https://apps.truenas.com/catalog/ebbwell_community/",
"https://github.com/Maxren2/ebbwell",
"https://github.com/Maxren2/ebbwell/pkgs/container/ebbwell"
],
"title": "Ebbwell",
"train": "community",
"version": "1.0.0"
}
}
}Support, maintenance, and documentation for applications within the Community catalog is handled by the TrueNAS community. The TrueNAS Applications Market hosts but does not validate or maintain any linked resources associated with this app.
There currently aren’t any resources available for this application!
Please help the TrueNAS community add resources here or discuss this application in the TrueNAS Community forum.


