{"id":15095838,"url":"https://github.com/sdebruyn/hass-auth-synology","last_synced_at":"2025-10-08T00:31:58.667Z","repository":{"id":37853114,"uuid":"427531108","full_name":"sdebruyn/hass-auth-synology","owner":"sdebruyn","description":"Authentication provider using Synology DSM users for Home Assistant","archived":true,"fork":false,"pushed_at":"2022-08-11T18:39:47.000Z","size":333,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-22T15:07:15.332Z","etag":null,"topics":["authentication","homeassistant","synology"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sdebruyn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-13T00:23:57.000Z","updated_at":"2023-07-25T15:03:53.000Z","dependencies_parsed_at":"2022-06-22T21:23:42.062Z","dependency_job_id":null,"html_url":"https://github.com/sdebruyn/hass-auth-synology","commit_stats":null,"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdebruyn%2Fhass-auth-synology","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdebruyn%2Fhass-auth-synology/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdebruyn%2Fhass-auth-synology/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdebruyn%2Fhass-auth-synology/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sdebruyn","download_url":"https://codeload.github.com/sdebruyn/hass-auth-synology/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235669382,"owners_count":19026815,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","homeassistant","synology"],"created_at":"2024-09-25T15:42:28.726Z","updated_at":"2025-10-08T00:31:53.386Z","avatar_url":"https://github.com/sdebruyn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Authentication provider using Synology DSM users for Home Assistant\n\n![PyPI](https://img.shields.io/pypi/v/hass-auth-synology)\n![GitHub branch checks state](https://img.shields.io/github/checks-status/sdebruyn/hass-auth-synology/main?label=build)\n![Codecov](https://img.shields.io/codecov/c/github/sdebruyn/hass-auth-synology?token=XC9UFW1RKH)\n![Maintenance](https://img.shields.io/maintenance/no/2022)\n![GitHub](https://img.shields.io/github/license/sdebruyn/hass-auth-synology)\n\nThe Synology authentication provider lets you authenticate using the users in your Synology DSM. Anyone with a user account on your Synology NAS will be able to login.\n\nThe provider supports 2-factor authentication, according to what is configured in DSM.\nWhen logging in, there will be a field to enter the 2FA code. The field is optional, but it should be used if your account in DSM requires 2FA. Otherwise, it can be left empty.\n\nThe use of 2FA within this provider is independent of the 2FA configuration in Home Assistant. If you enable 2FA in Home Assistant, and it is also enabled in Synology, you will have to enter 2 2FA codes.\n\nThe provider requires DSM 7.0 or newer.\n\n## Installation\n\n### Home Assistant Container\n\nUse this package's container instead of the Home Assistant one.\n\n```\nghcr.io/sdebruyn/hass-auth-synology:latest\n```\n\n### Home Assistant Core\n\nThe installation will have to be redone everytime you update Home Assistant.\n\n1. Make sure the Home Assistant virtualenv is activated: `source bin/activate`\n2. Install this package: `pip3 install hass-auth-synology`\n3. Run the installation command: `hass-auth-synology install`\n\n### Home Assistant Supervised\n\nThe installation will have to be redone everytime you update Home Assistant.\n\n1. Search for the “SSH \u0026 Web Terminal” add-on in the add-on store and install it.\n2. Configure the username and password/authorized_keys options.\n3. Start the “SSH \u0026 Web Terminal” add-on\n4. Run the following code through the web terminal:\n    ```shell\n    pip3 install hass-auth-synology\n   hass-auth-synology install\n    ```\n5. You can now disable and remove the “SSH \u0026 Web Terminal” add-on again.\n\n## Configuration\n\nAdd the following to your Home Assistant configuration:\n\n```yaml\nhomeassistant:\n  auth_providers:\n    - type: synology\n      host: nas.local\n      port: 443\n      secure: true\n      verify_cert: true\n```\n\n* `host`: IP address or hostname of your NAS.\n* `port`: Port on which DSM is available. Make sure to use one corresponding to HTTP or HTTPS as configured with `secure` .\n* `secure` (optional): Enable this to use HTTPS instead of HTTP. (default: false)\n* `verify_cert` (optional): Enable this to verify the certificate when using HTTPS (default: false).\nMake sure to disable this when using self-signed certificates or an IP address instead of a hostname.\nThe setting is ignored when `secure` is false.\n\n## Troubleshooting\n\nIf any errors occur, make sure to check your Home Assistant logs. If the connection succeeds, but authentication fails, Synology DSM will output an error code.\nThe meaning of the error code can be found [in the Synology DSM Login API documentation](https://global.download.synology.com/download/Document/Software/DeveloperGuide/Os/DSM/All/enu/DSM_Login_Web_API_Guide_enu.pdf).\n\nFeel free to open an issue on GitHub if you encounter any issues.\n\n## License \u0026 attribution\n\nApache v2.0\n\nTest utilities under `tests` are coming from [Home Assistant Core](https://github.com/home-assistant/core).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdebruyn%2Fhass-auth-synology","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdebruyn%2Fhass-auth-synology","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdebruyn%2Fhass-auth-synology/lists"}