https://github.com/niradler/authom-proxy
open-source authentication proxy service that simplifies the integration of various OAuth providers into your applications
https://github.com/niradler/authom-proxy
authentication proxy
Last synced: 10 months ago
JSON representation
open-source authentication proxy service that simplifies the integration of various OAuth providers into your applications
- Host: GitHub
- URL: https://github.com/niradler/authom-proxy
- Owner: niradler
- Created: 2024-08-30T23:50:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T14:47:21.000Z (almost 2 years ago)
- Last Synced: 2025-04-02T09:46:45.331Z (about 1 year ago)
- Topics: authentication, proxy
- Language: TypeScript
- Homepage: https://github.com/niradler/authom-proxy
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Authom Proxy
Authom 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.
## Features
- Support for multiple OAuth providers (Google, GitHub, Facebook, Twitter, LinkedIn, Microsoft, Apple, Amazon, Yahoo, Discord)
- Easy configuration through environment variables or a JSON file
- JWT-based session management
- Configurable allowed users list
- Docker and docker-compose support for easy deployment
- Traefik integration for reverse proxy and load balancing
## Getting Started
### Prerequisites
- Node.js (v14 or later)
- npm or yarn
- Docker and docker-compose (optional, for containerized deployment)
### Installation
1. Clone the repository:
```sh
git clone https://github.com/yourusername/authom-proxy.git
cd authom-proxy
```
2. Install dependencies:
```sh
npm install
```
3. Create a `.env` file in the root directory and add your configuration:
```sh
PORT=3000
JWT_SECRET=your_jwt_secret
ALLOWED_USERS=user1@example.com,user2@example.com
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
# Add other provider credentials as needed
```
4. Build the project:
```sh
npm run build
```
5. Start the server:
```sh
npm start
```
### Docker Deployment
To deploy using Docker and docker-compose:
1. Ensure you have Docker and docker-compose installed.
2. Create a `.env` file as described in the Installation section.
3. Run:
```sh
docker-compose up -d
```
## Usage
1. Configure your application to use Authom Proxy as an authentication middleware.
2. Direct users to `http://your-domain.com/auth/providers` to see available login options.
3. After successful authentication, users will be redirected to your application with an `X-Forwarded-User` header containing their email.
## Supported Providers
Authom Proxy supports the following OAuth providers out of the box:
1. Google (tested)
2. GitHub
3. Facebook
4. Twitter
5. LinkedIn
6. Microsoft
7. Apple
8. Amazon
9. Yahoo
10. Discord
## Configuration
Authom Proxy can be configured using environment variables or a `authom-proxy.json` file. See the `src/config.ts` file for available options.
### Configuring Providers
To 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:
1. Set the environment variables:
```sh
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
```
2. Alternatively, add the provider configuration to `authom-proxy.json`:
```json
{
"providers": {
"google": {
"clientId": "your_google_client_id",
"clientSecret": "your_google_client_secret",
"authUrl": "https://accounts.google.com/o/oauth2/v2/auth", //optional
"tokenUrl": "https://oauth2.googleapis.com/token", //optional
"profileUrl": "https://www.googleapis.com/oauth2/v1/userinfo", //optional
"scope": "https://www.googleapis.com/auth/userinfo.email" //optional
}
}
}
```
Adding custom provider:
```json
{
"providers": {
"custom": {
"authUrl": "https://customdomain.com/authorize",
"tokenUrl": "https://customdomain.com/oauth2/token",
"profileUrl": "https://customdomain.com/api/auth/userinfo",
"scope": "email"
}
}
}
```
## Contributing
We welcome contributions to Authom Proxy! Please follow these steps to contribute:
1. Fork the repository
2. Create a new branch for your feature or bug fix
3. Make your changes and commit them with a clear commit message
4. Push your changes to your fork
5. Create a pull request to the main repository
Please ensure your code adheres to the existing style and includes appropriate tests.
## License
This project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.
## Support
If you encounter any issues or have questions, please file an issue on the GitHub repository.