wba-openroaming-portal

KO | EN

gitlite — search

#python #ai #llm #rust #deep-learning #linux #docker #nodejs #macos #windows #awesome #awesome-list #ios #openai

wba-openroaming-portal

(★ 11)

WBA OpenRoaming Portal - OpenSource Version

wba-openroaming-portal 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🌐︎ OpenRoaming Provisioning Portal

Welcome to the OpenRoaming Provisioning Portal! This repository provides a **reference implementation designed to
baseline the industry** on the necessary components for developing an enabler component of OpenRoaming.

# Table of Contents

1. [Why It Was Created?](#why-it-was-created)

2. [How does it Work?](#how-does-it-work)

3. [Tools Used](#tools-used)

4. [Prerequisites](#prerequisites)

5. [How to Get the Project](#how-to-get-the-project)

6. [Features](#features)
    - [User Management](#user-management)
    - [Portal Management](#portal-management)
    - [Settings Management](#settings-management)
    - [Portal Statistics](#portal-statistics)
    - [Connectivity Statistics](#connectivity-statistics)

7. [OpenRoaming Portal API](#openroaming-portal-api)

8. [Installation Guide](#installation-guide)

9. [Upgrade Stop: Important Instructions for Future Updates](#upgrade-stop-important-instructions-for-future-updates)

10. [Portal Overview & Baseline Operation](#portal-overview--baseline-operation)
    - [Environment Variables](#environment-variables)
        - [Symfony Application Variables](#environment-variables)
        - [Google Client & Secret Credentials](#google-client-and-secret-credentials)
        - [Microsoft Authenticator Credentials](#microsoft-client-and-secret-credentials)
        - [SAML Specific Settings](#saml-specific-settings)
        - [Turnstile Integration](#turnstile-integration)
        - [GeoLite GUI Documentation](#geolite-gui-documentation)
        - [API Platform](#api-platform)
        - [JWT Tokens](#jwt-tokens)

11. [Admin Page Access Page](#admin-page-access-page)

12. [Set up a CRON Job for automation commands](#set-up-a-cron-job-for-automation-commands)

13. [Settings Table](#settings-table)

14. [Contact Information](#contact-information)

## Why it was created?

The primary goal of the **OpenRoaming Provisioning Portal is to simplify the provisioning of identities using
Passpoint**, enabling an OpenRoaming network to support seamless Wi-Fi connectivity and enhance security for users
across various environments.

The goal is to **provide secure Wi-Fi access to everyone** without the need for repeated logins or unsecure/open
networks, making Wi-Fi connectivity for individuals and enterprises easier, quicker, and more user-friendly.

## How does it work?

OpenRoaming is an **open standard developed to enable global, secure, and automatic Wi-Fi connectivity**. With
OpenRoaming, users can connect to Wi-Fi networks without being prompted for login credentials. Instead, it utilizes
digital certificates and secure authentication mechanisms to **ensure a seamless and secure connection experience**.
This technology allows users to quickly switch between Wi-Fi networks—such as public hotspots, venues, residencies,
corporate networks, and other places—without delays or multiple logins.

Each user is provided with a unique and secure profile that caters to their specific needs and preferences. The
OpenRoaming Provisioning Portal simplifies the setup and configuration process for network administrators, acting as a
key enabler for OpenRoaming technology.

For more information about OpenRoaming Technology, please visit: https://openroaming.org

## Tools Used

These are some of the most important tools used on the development of this project:

- **PHP**: Open source general-purpose scripting language that is especially suited for web development.
- **Symfony Framework**: The core of the portal, the Symfony framework provides a solid and scalable base for web
  applications.
- **Twig Templating Engine**: Generates consistent, responsive views by separating logic.
- **MySQL Database**: Efficient method to save and return user profiles and settings of the portal.
- **Docker**: Encapsulating the project in containers to improve deployment and compatibility.

## Prerequisites:

- Linux-based system - Ubuntu 22.04 LTS (tested for the reference implementation)
- Knowledge about Linux OS (required to set up the project)
- Radius DB and a stack IDP prepared to use the portal
- Docker (required for running the application)
- Docker compose (responsible for managing multiple containers)
- Git (optional, if the user prefers to clone the repository)

# Support Policy

Technical support is strictly limited to deployments that follow baseline deployment:

* **Supported Environments Only:** Assistance is exclusively provided for environments meeting the
   specified [Prerequisites](#prerequisites). Deployments on unsupported, custom, or undocumented environments are
   strictly out of scope.
* **Latest Production Release:** Support is only provided for the most recent stable version of the portal. Legacy
   or outdated versions will not receive troubleshooting, bug fixes, or patch assistance.
* **Zero Core Code Modifications:** The application must run on standard repository code. Any custom modifications,
   changes, or rewrites to the source code—excluding the documented environment variable configurations—will
   completely void support eligibility.

## How to get the Project

There are two options to retrieve the project:

1. **Download Release Package**: Download the release package from the releases section on GitHub. This package contains
   only the required components to run the OpenRoaming Provisioning Portal,
   including `.env.sample`, `docker-compose.yml`, and other necessary files.

2. **Clone the Repository**: If the user is familiar with Git and want to access the complete source code, can clone the
   repository using the following command:

```bash
- git clone <repository-url>
```

## Features

This section explains the basic concepts behind each portal component.

### User Management:

- **List User** : View a list of all registered users in the system, can be filtered by all/only verified/only banned
  and sorted by creation date, among others.
- **Edit User Data** : Edit user information.
- **Search User**: Find users using various searching is email/uuid.
- **Delete User**: Remove user accounts from the system, **not permanently**.
- **Export Users Table** Can export all the user table content, this feature is disabled by default for legal and
  security reasons.

### Portal Management

All the present items can be customizable:

- **Show Customer Logo**
- **Customer Logo**
- **Openroaming Logo**
- **Wallpaper Image**
- **Page Title**
- **Welcome Text**
- **Welcome Description**
- **Additional Label**
- **Contact Email**

### Settings Management

- **Platform Status (Live/Demo)**
- **API Status**
- **Landing Page Configuration**
- **Terms and Policies**
- **Schedule Automation for CRON's**
- **Radius Configuration**
- **Authentication Methods**
- **Two Factor Authenticator**
- **LDAP Synchronization**
- **Profile Radius Configuration**
- **User Engagement**
- **SMS Configuration**

### Portal Statistics

This page shows data related to the user created on the portal

- **Devices**: Type of devices on the portal (Android, Windows, macOS, iOS)
- **Authentication**: Type of authentications present on the portal: (SAML, Google, Portal)
- **Portal with SMS or Email**: Shows data related to authentications on the portal (SMS & Email)
- **User Created in**: Shows data about creation of users in demo/live mode
- **User Management**: Shows data about the verification (verified/banned/need verification)

### Connectivity Statistics

This page shows data related to the hybrid machine

- **Authentication Attempts**: Shows number of attempts (Accepted/Rejected)
- **Session Time**: Shows the session time spent connected with a profile, of each user (Average/Total in hours)
- **Total of Traffic**: Shows the traffic passed between the freeradius and the user profile (Uploads/Downloads)
- **Realms Usage**: Number of devices connected using the realm from the portal
- **Total of Current Authentications** Shows the number of current users connected with a profile (This card is
  independent of the date filtering)

## OpenRoaming Portal API

This page shows data related to the endpoints in the project required for user authentication, management, and
configuration within the OpenRoaming Portal. It includes detailed descriptions of each endpoint, highlighting their
purpose, required inputs, and expected outputs.

Additionally, the documentation shows the necessary security measures,
such as CAPTCHA validation, that are integrated to protect user data and ensure secure interactions with the API.

Please refer to the [API documentation](docs/Api/V3/index_v3.html) for detailed usage instructions and examples.

Follow this link for more information on API documentation: [Api Guide](docs/APIGUI.md)

## Upgrade Stop: Important Instructions for Future Updates

Certain upgrades may require additional steps or preparation to ensure a smooth and successful transition. These steps
are vital to maintaining the integrity of your system and avoiding issues caused by breaking changes. Always adhere to
the instructions provided for each version you are upgrading to.

> **Important**: Failure to follow the required upgrade steps may result in incomplete migrations, unexpected behaviors,
> or portal downtime.

Follow this link for more information about upgrading this
project: [Upgrade Guide](docs/UPGRADE.md).

# Installation Guide

Follow this link for more information on installing this
project: [Installation Guide](docs/INSTALLATION.md).

# AssetMapper

If you notice any issues with styling or frontend assets, please refer
to [ASSETMAPPER Configurations](./docs/ASSETMAPPER.md).

# Admin Page Access Page

Follow this link for a portal user/admin interface overview: [Portal Guide](docs/PORTALGUI.md).

# Portal Overview & Baseline Operation

The objective is for the user to get familiarized with the project and its baseline features.

## Platform Mode (Demo or Live)

The project provides two modes: Platform mode set to **DEMO** or **LIVE**, each serving to different needs.

- **Platform Mode (Demo)**: When platform mode is set to DEMO, the system generates demo profiles based on the submitted
  email.
  This allows users to explore and test the portal's functionality without the need to create a user account. In demo
  mode, only "demo login" is displayed, and SAML and other login methods are disabled, regardless of other settings. A
  demo warning is also displayed, indicating that the system is in demo mode. **PLEASE DO NOT USE THIS IN PRODUCTION.**
  This mode can't be used because externally due to legal implications in this type of environment.

When this mode is activated, **it's not required** to verify the user account several times.

- **Platform Mode (Live)**: When platform mode is set to LIVE, profiles are generated based on
  individual user accounts inside the project. This offers a completely customized and secure Wi-Fi experience adapted
  to the interests and needs of each user. Users can set up accounts in production mode and use all available login
  methods, including SAML and Google authentication.

When this mode is activated, **it's required** to verify the account every time the user wants to download a profile
again, because it's a new demo account being generated on the portal.

Follow this link for a portal user interface overview: [Portal Guide](docs/PORTALGUI.md).

## Environment Variables

The OpenRoaming Provisioning Portal utilizes environment variables for its configuration.
Below is an overview of the different variables and their functions:

- `APP_ENV`: This sets the environment mode for the Symfony application. It can be `dev` or `prod`.
- `APP_SECRET`: This is the application secret used by Symfony for encrypting cookies and generating CSRF tokens.
- `DATABASE_URL`: This is the connection string for the primary MySQL database. It should be in the
  format `mysql://user:pass@host:port/dbname`.
- `DATABASE_FREERADIUS_URL`: This is the connection string for the FreeRADIUS MySQL database, used for RADIUS related
  operations. It should be in the format `mysql://user:pass@host:port/dbname`.
- `MESSENGER_TRANSPORT_DSN`: This defines the transport (e.g., AMQP, Doctrine, etc.) that Symfony Messenger will use for
  dispatching messages. The value `doctrine://default?auto_setup=0` uses Doctrine DBAL with auto setup disabled.
- `MAILER_DSN`: This specifies the method of transport used to send emails with the Symfony Mailer component.
  Examples:
    ```dotenv
    # This are just a examples, please DO NOT USE IT
    # Example 1: Sending emails via SMTP (e.g., Gmail)
    MAILER_DSN=smtp://user:password@smtp.gmail.com:587?encryption=tls&auth_mode=login

# Example 2: Using the default email transport (using PHP's mail() function)
    MAILER_DSN=mail://default
    ```
- `EMAIL_ADDRESS`: Entity of sends the emails to the users
- `SENDER_NAME`: Entity sender name
- `BUDGETSMS_API_URL`: This env manages the budget SMS link of the API, is not necessary to change this env.
- `EXPORT_USERS`: This env manages the operation to export all the **User table** content, this is disabled by default
  for legal and security reasons.
- `EXPORT_FREERADIUS_STATISTICS`: Manages the export of FreeRADIUS statistics from the admin page.

These two envs are for debugging purposes, they only should be used to control and manage reports from the portal.
`SENTRY_DSN`& `TRUSTED_PROXIES`.

- `ENABLE_DELETE_USERS_UI`: Shows a button on the UI, to be able to remove users from the
  portal.
  This action doesn't remove users, only encrypts the data with PGP (Pretty Good Privacy).

Please make sure to set up a **public_key** in (pgp_public_key/public_key.asc)
**do not create keys on the production server**.

### Default_URL Configuration

- `DEFAULT_URI` – The base URL used by Symfony to generate absolute links. **Required in production** and must not point
  to `localhost` or `127.0.0.1`.

### Google Client and Secret Credentials

For detailed steps on how to obtain your **Google Client ID** and **Google Client Secret**, please refer to
the [Google Client ID and Secret Guide](docs/ProvidersGuides/GOOGLE_CLIENT.md).
Once obtained, you will use the following environment variables in your portal configuration:

- `GOOGLE_CLIENT_ID`
- `GOOGLE_CLIENT_SECRET`

### Microsoft Client and Secret Credentials

For detailed instructions on how to obtain your **Microsoft Client ID** and **Microsoft Client Secret**, please refer to
the [Microsoft Client ID and Secret Guide](docs/ProvidersGuides/MICROSOFT_CLIENT.md).

Once obtained, you will use the following environment variables in your portal configuration:

- `MICROSOFT_CLIENT_ID`
- `MICROSOFT_CLIENT_SECRET`

### SAML Specific Settings

These variables are needed to set up the SAML Service Provider (SP) and Identity Provider (IdP):

For detailed instructions on how to obtain your **SAML IDP Credentials**, please refer to
the [SAML Service Provider (SP)](docs/ProvidersGuides/SAML_IDP_CREDENTIALS.md).

- `SAML_IDP_ENTITY_ID`: This is the entity ID (URI) of the IdP.
- `SAML_IDP_SSO_URL`: This is the URL of the IdP's Single Sign-On (SSO) service.
- `SAML_IDP_X509_CERT`: This is the X509 certificate from the IdP, used for verifying SAML responses.
- `SAML_SP_ENTITY_ID`: This is the entity ID (URI) of the SP.
- `SAML_SP_ACS_URL`: This is the URL of the SP's Assertion Consumer Service (ACS), which processes SAML assertions from
  the IdP.
- `SAML_IDENTIFIER_ATTRIBUTE`: Defines which SAML attribute is used as the unique user identifier when matching users in
  the system. Allowed values: sAMAccountName, email, uid, username. Only one value must be selected.
- `SAML_ATTRIBUTE_MAPPING`: Defines the mapping between SAML attributes and the application user fields.
  This allows each Identity Provider (IdP) to map its own attribute names to the system’s expected user fields during
  authentication and user creation.
  Example fields include: `uuid`, `email`, `first_name`, `last_name`.
  The value must be a valid JSON object where each key represents a user field and each value represents the
  corresponding SAML attribute name from the IdP.

**Important**:
If you want to use this provider authentication on the project,
make sure to expose a SAML attribute on your IDP named
`samlUuid`,
to expose a unique id of the SAML account.
This property it's required to authenticate users if one of them doesn't have an email defined on the IDP.

### Turnstile Integration

These two are used to configure the Turnstile integration with the portal, to check and validate actual users.

- `TURNSTILE_KEY`: Stores the public key for Cloudflare Turnstile integration.
- `TURNSTILE_SECRET`: Holds the secret key for Cloudflare Turnstile integration.

For **testing** purposes with Cloudflare Turnstile, please use this
link: [Cloudflare Turnstile Testing](https://developers.cloudflare.com/turnstile/troubleshooting/testing/).

And for any **production deployment**, please follow the
link: [Cloudflare Turnstile Production Guide]( https://developers.cloudflare.com/turnstile/get-started/).

### GeoLite GUI Documentation

For detailed instructions on the GeoLite GUI setup, operations, and usage, refer to
the [GeoLite GUI Guide](docs/GEOLITEGUI.md).

### API Platform

The following configurations are required for the API of the project.

- `CORS_ALLOW_ORIGIN`: Required to let the project know which domain is able to use the API, is not necessary to change
  this env.

#### Jwt Tokens

If you are planning on using the API, please make sure to run the following command on the root folder of the container
project:

```bash
php bin/console lexik:jwt:generate-keypair
```

A **public** && **private** keys will be automatically generated. If you want to know where they will be placed, please
check the `.env.sample`.

- `JWT_SECRET_KEY`: The secret defined for the key.
- `JWT_PUBLIC_KEY`: The public key location.
- `JWT_PASSPHRASE`: The private key location.
- `JWT_EXPIRATION`: The expiration date of the token.

### Set up a CRON Job for automation commands

For reference, all the previous documentation related to the **CRONGUI.md** was discontinued. Now the framework
handles all this automation, and the supervisor configuration takes cares of the process. If you want to run the
configuration command by yourself, you can run the following command:

```bash
php bin/console messenger:consume scheduler_default -vv
```

Also, all this setup is configured on the following file: `src/Schedule.php`

## Admin Page Access Page

Follow this link for a portal user/admin interface overview: [Portal Guide](docs/PORTALGUI.md).

### Settings Table

The OpenRoaming Provisioning Portal has a detailed "setting" table that allows you to customize the application to your
individual needs. Here's a rundown of several important variables and their functions:

1. `RADIUS_REALM_NAME`: The realm name for your RADIUS server.
2. `DISPLAY_NAME`: The name used on the profiles.
3. `PAYLOAD_IDENTIFIER`: The identifier for the payload used on the profiles.
4. `OPERATOR_NAME`: The operator name used on the profiles.
5. `DOMAIN_NAME`: The domain name used for the service.
6. `RADIUS_TLS_NAME`: The hostname of your RADIUS server used for TLS.
7. `NAI_REALM`: The realm used for Network Access Identifier (NAI).
8. `RADIUS_TRUSTED_ROOT_CA_SHA1_HASH`: The SHA1 hash of your RADIUS server's trusted root CA (Defaults to LetsEncrypt
   CA).

**IMPORTANT**: The LetsEncrypt CA's SHA1 hash is set as the default value.
This hash is important since it is necessary
to validate the RADIUS server's certificate.

**Missing Values:** Please check that all crucial fields are fully filled if any values are missing.
Pay attention to the UUID field (domain of your portal).
It's critical to provide a unique UUID that differs from the default.
The Same uuid may result in conflicts between different portals, resulting in profile overrides.

If you use a different CA for your RADIUS server, you must replace this value with the SHA1 hash of your CA's root
certificate. **Connection errors** can happen if the right SHA1 hash is not provided.

1. `PLATFORM_MODE`: Live || Demo.
   When in Demo, only "demo login" is displayed, and SAML and other login
   methods are disabled regardless of other settings. A demo warning will also be displayed.
2. `USER_VERIFICATION`: ON || OFF.
   When it\'s ON it activates the email verification system.
   This system requires all
   the users to verify its own account before they download any profile.
3. `TURNSTILE_CHECKER`: ON || OFF.
   When it\'s ON, it activates the turnstile verification system.
   This system requires all
   the users to check and verify is session before creating an account.
   To prevent bots.
4. `API_STATUS`: Defines whether the API is enabled or disabled.

5. `PAGE_TITLE`: The title displayed on the webpage.
6. `CUSTOMER_LOGO_ENABLED`: Shows the customer logo on the landing page.
7. `CUSTOMER_LOGO`: The resource path or URL to the customer logo image.
8. `OPENROAMING_LOGO`: The resource path or URL to the OpenRoaming logo image.
9. `WALLPAPER_IMAGE`: The resource path or URL to the wallpaper image.
10. `WELCOME_TEXT`: The welcome text displayed on the user interface.
11. `WELCOME_DESCRIPTION`: The description text displayed under the welcome text.
12. `VALID_DOMAINS_GOOGLE_LOGIN`: Defines the valid domains to authenticate with Google, when it's empty, he lets anyone
    with a Google account login.
13. `VALID_DOMAINS_MICROSOFT_LOGIN`: Defines the valid domains to authenticate with Microsoft Azure, when it's empty, he
    lets anyone
    with a Microsoft account login.
14. `CONTACT_EMAIL`: The email address for contact inquiries.

15. `AUTH_METHOD_SAML_ENABLED`: Enable or disable SAML authentication method.
16. `AUTH_METHOD_SAML_LABEL`: The label for SAML authentication button on the login page.
17. `AUTH_METHOD_SAML_DESCRIPTION`: The description for SAML authentication on the login page.
18. `AUTH_METHOD_GOOGLE_LOGIN_ENABLED`: Enable or disable Google authentication method.
19. `AUTH_METHOD_GOOGLE_LOGIN_LABEL`: The label for Google authentication button on the login page.
20. `AUTH_METHOD_GOOGLE_LOGIN_DESCRIPTION`: The description for Google authentication on the login page.
21. `AUTH_METHOD_MICROSOFT_LOGIN_ENABLED`: Enable or disable Google authentication method.
22. `AUTH_METHOD_MICROSOFT_LOGIN_LABEL`: The label for Google authentication button on the login page.
23. `AUTH_METHOD_MICROSOFT_LOGIN_DESCRIPTION`: The description for Google authentication on the login page.
24. `AUTH_METHOD_REGISTER_METHOD_ENABLED`: Enable or disable Register authentication method.
25. `AUTH_METHOD_REGISTER_METHOD_LABEL`: The label for Register authentication button on the login page.
26. `AUTH_METHOD_REGISTER_METHOD_DESCRIPTION`: The description for Register authentication on the login page.
27. `AUTH_METHOD_LOGIN_TRADITIONAL_ENABLED`: Enable or disable Login (email) authentication method.
28. `AUTH_METHOD_LOGIN_TRADITIONAL_LABEL`: The label for Login (email) authentication button on the login page.
29. `AUTH_METHOD_LOGIN_TRADITIONAL_DESCRIPTION`: The description for Login (email) authentication on the login page.
30. `LOGIN_WITH_UUID_ONLY`: Enabled or disabled only UUID authentication, this method sends a confirmation code instead
    of the tradicional uuid & password.
31. `AUTH_METHOD_SMS_REGISTER_ENABLED`: Enable or disable Login (SMS) authentication method.
32. `AUTH_METHOD_SMS_REGISTER_LABEL`: The label for Login (SMS) authentication button on the login page.
33. `AUTH_METHOD_SMS_REGISTER_DESCRIPTION`: The description for Login (SMS) authentication on the login page.

34. `TWO_FACTOR_AUTH_STATUS`: The status of two-factor authentication when users log in to the platform.
35. `TWO_FACTOR_AUTH_APP_LABEL`: Platform identifier in two-factor application
36. `TWO_FACTOR_AUTH_APP_ISSUER`: Issuer identifier in two-factor application
37. `TWO_FACTOR_AUTH_CODE_EXPIRATION_TIME`: Local two-factor authentication code expiration time
38. `TWO_FACTOR_AUTH_ATTEMPTS_NUMBER_RESEND_CODE`: Number of attempts to request resending of the two-factor
    authentication code
39. `TWO_FACTOR_AUTH_TIME_RESET_ATTEMPTS`: Time in minutes to reset attempts to send two-factor
    authentication code
40. `TWO_FACTOR_AUTH_RESEND_INTERVAL`: Time interval in seconds to request a new two-factor authentication code

41. `SYNC_LDAP_ENABLED`: Enable or disable synchronization with LDAP.
42. `SYNC_LDAP_SERVER`: The LDAP server's URL.
43. `SYNC_LDAP_BIND_USER_DN`: The Distinguished Name (DN) used to bind to the LDAP server.
44. `SYNC_LDAP_BIND_USER_PASSWORD`: The password for the bind user on the LDAP server.
45. `SYNC_LDAP_SEARCH_BASE_DN`: The base DN used when searching the LDAP directory.
46. `SYNC_LDAP_SEARCH_FILTER`: The filter used when searching the LDAP directory.
    The placeholder `@ID` is replaced with the user's ID.

47. `PROFILES_ENCRYPTION_TYPE_IOS_ONLY`: Type of encryption defined for the creation of the profiles, for iOS only.
48. `CAPPORT_ENABLED`: Enable or disable Capport DHCP configuration.
49. `CAPPORT_PORTAL_URL`: Domain that is from the entity hosting the service.
50. `CAPPORT_VENUE_INFO_URL`: Domain where the user is redirected after clicking the DHCP notification.
51. `SMS_ACTIVE_PROVIDER`: Current activated SMS provider.
54. `SMS_FROM`: Entity sending the SMS for the users.
55. `SMS_TIMER_RESEND`: Timer in minutes to make the user wait to resend a new SMS.

56. `EMAIL_TIMER_RESEND`: Time in minutes to make the user wait to resend a new EMAIL for reset password request.
57. `LINK_VALIDITY`: Time in minutes a link stays active before it expires.

58. `TOS_LINK`: Term's and Conditions URL.
59. `PRIVACY_POLICY_LINK`: Privacy and Policy URL.
60. `USER_DELETE_TIME`: Time in hours to delete the unverified user.
61. `TIME_INTERVAL_NOTIFICATION`: Time in days to resend the notification when the profile is about to expire.
62. `PROFILE_LIMIT_DATE_SAML`: Time in days to disable profiles for SAML users with login.
63. `PROFILE_LIMIT_DATE_GOOGLE`: Time in days to disable profiles for users with GOOGLE login.
64. `PROFILE_LIMIT_DATE_MICROSOFT`: Time in days to disable profiles for users with MICROSOFT login.
65. `PROFILE_LIMIT_DATE_EMAIL`: Time in days to disable profiles for users with EMAIL login.
66. `PROFILE_LIMIT_DATE_SMS`: Time in days to disable profiles for users with SMS login.
67. `DELETE_UNCONFIRMED_USERS_CRON`: Defines the schedule to delete unconfirmed users from the portal.
68. `USERS_WHEN_PROFILE_EXPIRES_CRON`: Defines the schedule to notify the users when their profile to expire.
69. `LDAP_SYNC_CRON`: Defines the schedule for LDAP synchronization automation command.
70. `CRON_ADVANCED_STATUS`:  Saves the previous status mode on the schedule cron configuration page (Simple/Advanced)
71. `DOMAIN_BLACKLIST_IMPORT_CRON`: Defines the schedule to import/refresh Blacklist of domains.
72. `CLOUDFLARE_TOKEN` : Token for automatic Cloudflare certificate renewal.
73. `ENABLE_RADIUS_TLS_RESET`: Saves the current state of the **RADIUS_TLS_NAME**, if this is set to false the reset
    certs widget will ask for a new radius_tls_name to be configured. **Careful when setting up this stage to be the
    actual RADIUS_TLS_NAME on the free-radius resolver. For more details consul this **
74. `RETURN_APPS_ENABLED`: Enables or disables the return-to-apps configuration for mobile devices. If set to false, the
    asset association endpoints will not be exposed, preventing Android and iOS applications from linking to the portal.
75. `RETURN_APPS_PACKAGE_NAME_ANDROID`: Defines the application identifier used for mobile app association for Android,
    this corresponds to the package name (e.g., com.example.app).
76. `RETURN_APPS_ID_IOS`: Defines the application identifier used for mobile app association for iOS, this follows
    the TEAMID.bundleId format required for Apple App Site Association.
77. `EMAIL_TIME_INTERVAL_TO_RESET_ATTEMPTS`: Time window (in minutes) after which the email request attempts counter is reset
78. `EMAIL_TIME_INTERVAL_BETWEEN_REQUESTS`: Minimum cooldown (in seconds) between consecutive email requests
79. `EMAIL_ATTEMPTS_NUMBER`: Maximum number of allowed requests within the defined time window
80. `SMS_TIME_INTERVAL_TO_RESET_ATTEMPTS`: Time window (in minutes) after which the SMS request attempts counter is reset
81. `SMS_TIME_INTERVAL_BETWEEN_REQUESTS`: Minimum cooldown (in seconds) between consecutive SMS requests
82. `SMS_ATTEMPTS_NUMBER`: Maximum number of allowed requests within the defined time window
83. `BREAKING_GLASS_ADMIN_EMAIL`: Defines the email for the one time usage admin account.
84. `DELETE_UNCONFIRMED_USERS_CRON_ENABLED`: Enables or disables the automatic deletion of unconfirmed users cron job.
85. `USERS_WHEN_PROFILE_EXPIRES_CRON_ENABLED`: Enables or disables the automatic notification cron job for users whose
    profile is about to expire.
86. `LDAP_SYNC_CRON_ENABLED`: Enables or disables the automatic LDAP synchronization cron job.
87. `DOMAIN_BLACKLIST_IMPORT_CRON_ENABLED`: Enables or disables the automatic domain blacklist import and
    synchronization cron job.

#### With these environment variables, you can configure and customize various aspects of the project, such as database connections, SAML settings, login methods, and more.

## Contact Information?

For more information please contact: openroaming@wballiance.com

## Prometheus Metrics

The portal exposes metrics for monitoring using Prometheus. The metrics are available at the `/metrics` endpoint.

### Available Metrics

- **Users**: Total users, verified users, and banned users
- **Authentication Providers**: Users by provider (Portal Account, SAML Account, Google Account, Microsoft Account) and
  portal users by type (Email, Phone Number)
- **Radius Profiles**: Profiles by status, total profiles, and total radius users from the radius database

### Configuration

Please refer to the Prometheus metrics documentations [Prometheus Metrics Configurations](docs/METRICS.md).

wba-openroaming-portal

wba-openroaming-portal 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

wba-openroaming-portal

wba-openroaming-portal 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README