{"id":13524259,"url":"https://github.com/joshp23/YOURLS-OIDC","last_synced_at":"2025-04-01T02:30:57.494Z","repository":{"id":40575477,"uuid":"223578986","full_name":"joshp23/YOURLS-OIDC","owner":"joshp23","description":"OpenID Connect Authentication for YOURLS","archived":false,"fork":false,"pushed_at":"2022-05-01T16:17:14.000Z","size":26,"stargazers_count":7,"open_issues_count":10,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-02T08:32:09.938Z","etag":null,"topics":["oidc","oidc-client","sso-client","yourls-plugin"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joshp23.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":"2019-11-23T11:39:35.000Z","updated_at":"2023-11-23T21:11:07.000Z","dependencies_parsed_at":"2022-08-09T23:32:01.560Z","dependency_job_id":null,"html_url":"https://github.com/joshp23/YOURLS-OIDC","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshp23%2FYOURLS-OIDC","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshp23%2FYOURLS-OIDC/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshp23%2FYOURLS-OIDC/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshp23%2FYOURLS-OIDC/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshp23","download_url":"https://codeload.github.com/joshp23/YOURLS-OIDC/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246572225,"owners_count":20798920,"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":["oidc","oidc-client","sso-client","yourls-plugin"],"created_at":"2024-08-01T06:01:08.453Z","updated_at":"2025-04-01T02:30:57.255Z","avatar_url":"https://github.com/joshp23.png","language":"PHP","funding_links":[],"categories":["Plugins"],"sub_categories":["O"],"readme":"# YOURLS-OIDC\nOpenID Connect Authentication for YOURLS\n\nThis plugin enables authentication against a generic OpenID Connect server in YOURLS. \n\n### Features\n- Respects YOURLS auth flow\n- Respects YOURLS hard-coded logins, if desired\n- Can link OpenID Connect accounts to existing YOURLS accounts\n- Sets user to `sub`, sets display name to `preferred_username`\n- Single Sign Out: signing out of YOURLS signs off OIDC server.\n\n### Requirements\n- YOURLS 7.4.0\n- The [jumbojett/OpenID-Connect-PHP](https://github.com/jumbojett/OpenID-Connect-PHP) library\n- `composer`, `php-curl`, `php-xml`, and `php-json`\n- A working OpenID Connect servier (Tested against Keycloak)\n- If installed, remove [dgw/yourls-dont-track-admins](https://github.com/dgw/yourls-dont-track-admins), or replace it with [joshp23/YOURLS-No-Tracking-Admins](https://github.com/joshp23/YOURLS-No-Tracking-Admins) for compatability.\n\n### Installation\n1. Download this repo and extract the `oidc` folder into `YOURLS/user/plugins/`\n2. `cd` to the directory you just created\n3. Run `composer install` in that directory to fetch the OIDC library\n4. Define OIDC server parameters (see below)\n5. configure OIDC, see below.\n6. Enable in Admin\n\nConfiguration\n-------------\nConfig: `user/config.php` file.\n```\n// oidc server\ndefine( 'OIDC_BASE_URL', 'https://keycloak.example.com/auth/realms/master/' );\ndefine( 'OIDC_CLIENT_NAME', 'YOURLS' );\ndefine( 'OIDC_CLIENT_SECRET', 'YOUR-SUPER-SECRET-HASH' );\n// Option 1: link OIDC users to local YOURLS users\n$oidc_profiles = array( \n\t'YOURLS_UNAME' =\u003e 'sub attribute from OIDC provider',\n);\n// Option 2, all users on OIDC platform have YOURLS accounts. uses 'preferred_username' attribute\ndefine( 'OIDC_BYPASS_YOURLS_AUTH', true );\n```\n### In Development\n- Tight integration with AuthMgrPlus\n\t- Group and attribute assignment\n- User panel in admin for linking to existing accounts with the push of a button\n\n### Tips\nDogecoin: DARhgg9q3HAWYZuN95DKnFonADrSWUimy3\n\nLicense\n-------\nCopyright 2019 Joshua Panter  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshp23%2FYOURLS-OIDC","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshp23%2FYOURLS-OIDC","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshp23%2FYOURLS-OIDC/lists"}