{"id":22982363,"url":"https://github.com/niradler/authom-proxy","last_synced_at":"2025-08-19T22:18:00.285Z","repository":{"id":255675801,"uuid":"850123878","full_name":"niradler/authom-proxy","owner":"niradler","description":" open-source authentication proxy service that simplifies the integration of various OAuth providers into your applications","archived":false,"fork":false,"pushed_at":"2024-09-06T14:47:21.000Z","size":64,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T09:46:45.331Z","etag":null,"topics":["authentication","proxy"],"latest_commit_sha":null,"homepage":"https://github.com/niradler/authom-proxy","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/niradler.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-30T23:50:04.000Z","updated_at":"2024-09-06T14:47:25.000Z","dependencies_parsed_at":"2024-09-06T17:33:29.140Z","dependency_job_id":"d32c8111-514a-44b7-948b-c7c14ca562a8","html_url":"https://github.com/niradler/authom-proxy","commit_stats":null,"previous_names":["niradler/authom-proxy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/niradler/authom-proxy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niradler%2Fauthom-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niradler%2Fauthom-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niradler%2Fauthom-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niradler%2Fauthom-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/niradler","download_url":"https://codeload.github.com/niradler/authom-proxy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niradler%2Fauthom-proxy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271231306,"owners_count":24723115,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","proxy"],"created_at":"2024-12-15T02:18:04.204Z","updated_at":"2025-08-19T22:18:00.232Z","avatar_url":"https://github.com/niradler.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Authom Proxy\n\nAuthom Proxy is an open-source authentication proxy service that simplifies the integration of various OAuth providers into your applications. It provides a unified interface for handling authentication across multiple platforms, making it easier to secure your services and manage user access.\n\n## Features\n\n- Support for multiple OAuth providers (Google, GitHub, Facebook, Twitter, LinkedIn, Microsoft, Apple, Amazon, Yahoo, Discord)\n- Easy configuration through environment variables or a JSON file\n- JWT-based session management\n- Configurable allowed users list\n- Docker and docker-compose support for easy deployment\n- Traefik integration for reverse proxy and load balancing\n\n## Getting Started\n\n### Prerequisites\n\n- Node.js (v14 or later)\n- npm or yarn\n- Docker and docker-compose (optional, for containerized deployment)\n\n### Installation\n\n1. Clone the repository:\n\n   ```sh\n   git clone https://github.com/yourusername/authom-proxy.git\n   cd authom-proxy\n   ```\n\n2. Install dependencies:\n\n   ```sh\n   npm install\n   ```\n\n3. Create a `.env` file in the root directory and add your configuration:\n\n   ```sh\n   PORT=3000\n   JWT_SECRET=your_jwt_secret\n   ALLOWED_USERS=user1@example.com,user2@example.com\n   GOOGLE_CLIENT_ID=your_google_client_id\n   GOOGLE_CLIENT_SECRET=your_google_client_secret\n   # Add other provider credentials as needed\n   ```\n\n4. Build the project:\n\n   ```sh\n   npm run build\n   ```\n\n5. Start the server:\n\n   ```sh\n   npm start\n   ```\n\n### Docker Deployment\n\nTo deploy using Docker and docker-compose:\n\n1. Ensure you have Docker and docker-compose installed.\n2. Create a `.env` file as described in the Installation section.\n3. Run:\n\n   ```sh\n   docker-compose up -d\n   ```\n\n## Usage\n\n1. Configure your application to use Authom Proxy as an authentication middleware.\n2. Direct users to `http://your-domain.com/auth/providers` to see available login options.\n3. After successful authentication, users will be redirected to your application with an `X-Forwarded-User` header containing their email.\n\n## Supported Providers\n\nAuthom Proxy supports the following OAuth providers out of the box:\n\n1. Google (tested)\n2. GitHub\n3. Facebook\n4. Twitter\n5. LinkedIn\n6. Microsoft\n7. Apple\n8. Amazon\n9. Yahoo\n10. Discord\n\n## Configuration\n\nAuthom Proxy can be configured using environment variables or a `authom-proxy.json` file. See the `src/config.ts` file for available options.\n\n### Configuring Providers\n\nTo enable a provider, you need to set the corresponding environment variables or add them to your `authom-proxy.json` file. For example, to enable Google authentication:\n\n1. Set the environment variables:\n\n```sh\nGOOGLE_CLIENT_ID=your_google_client_id\nGOOGLE_CLIENT_SECRET=your_google_client_secret\n```\n\n2. Alternatively, add the provider configuration to `authom-proxy.json`:\n\n```json\n{\n  \"providers\": {\n    \"google\": {\n      \"clientId\": \"your_google_client_id\",\n      \"clientSecret\": \"your_google_client_secret\",\n      \"authUrl\": \"https://accounts.google.com/o/oauth2/v2/auth\", //optional\n      \"tokenUrl\": \"https://oauth2.googleapis.com/token\", //optional\n      \"profileUrl\": \"https://www.googleapis.com/oauth2/v1/userinfo\", //optional\n      \"scope\": \"https://www.googleapis.com/auth/userinfo.email\" //optional\n    }\n  }\n}\n```\n\nAdding custom provider:\n```json\n{\n  \"providers\": {\n  \"custom\": {\n    \"authUrl\": \"https://customdomain.com/authorize\",\n    \"tokenUrl\": \"https://customdomain.com/oauth2/token\",\n    \"profileUrl\": \"https://customdomain.com/api/auth/userinfo\",\n      \"scope\": \"email\"\n    }\n  }\n}\n```\n\n## Contributing\n\nWe welcome contributions to Authom Proxy! Please follow these steps to contribute:\n\n1. Fork the repository\n2. Create a new branch for your feature or bug fix\n3. Make your changes and commit them with a clear commit message\n4. Push your changes to your fork\n5. Create a pull request to the main repository\n\nPlease ensure your code adheres to the existing style and includes appropriate tests.\n\n## License\n\nThis project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.\n\n## Support\n\nIf you encounter any issues or have questions, please file an issue on the GitHub repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniradler%2Fauthom-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fniradler%2Fauthom-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniradler%2Fauthom-proxy/lists"}