A simple, efficient, and scalable solution to deploy and manage an OpenConnect VPN server (ocserv)
with a powerful web-based dashboard.
Easily manage users, groups, and server configurations while keeping your VPN secure and performant.
Dashboard UI Preview
- Create, update, remove, block, and disconnect users with ease.
- Sync the
ocpasswdfile with the database to keep user credentials consistent. - Set traffic usage limits per user (e.g., GB or monthly quotas).
- Manage account expiration to automatically deactivate users when their subscription ends.
- Create, update, and delete user groups.
- Sync the
/etc/ocserv/groups/*files with the database to ensure consistent group configurations. - Organize users into logical groups for easier management.
- Use the
occtlCLI utility to perform various server operations efficiently.
- View real-time statistics for user traffic (RX/TX).
- Track data usage per user and per group.
- Monitor Ocserv logs in real-time directly from the web dashboard.
- Manage admin accounts: create, update, delete, and reset passwords.
- Track staff activities and administrative actions for accountability.
- Each staff member can create and manage their own Ocserv Users and Groups.
Staff members cannot view or modify users/groups created by others;
only admin users have full access.
- View detailed customer account information.
- Monitor user-specific usage summaries and traffic data.
- Multi-language support:
- English (en)
- Russian (ru)
- Simplified Chinese (zh-cn)
- Traditional Chinese (zh-tw)
- Arabic (ar)
- Persian (fa)
- Self-service Telegram bot that lets your customers interact with their VPN accounts:
- Link existing account: customers send their VPN username/password to the bot to associate it with their Telegram chat. One chat can manage many accounts.
- Usage check: customers see remaining quota, expiry date and online status for each linked account on demand.
- Renewal requests: customers pick a package and submit a renewal request. The admin is notified in Telegram.
- New account orders: new customers can order a fresh account by picking a package and a desired username.
- Receipt-based payment workflow: after admin approval the customer is asked to upload a payment receipt (photo). The admin reviews the receipt in the dashboard, confirms the payment and the bot automatically delivers the credentials (or extends the existing account).
- Low-quota warnings: customers receive an automatic warning message when remaining quota drops below a configurable threshold (default 200 MB).
- Multi-language: bot conversations and notifications are available in English and Persian, selectable per chat.
- Admin-side dashboard pages (under the
Telegramsection in the sidebar):- Settings: enable/disable the bot, paste the BotFather token, set admin chat ID, low-quota threshold, default language and Ocserv host.
- Packages: CRUD for the plans customers can pick (title, days, traffic size, traffic type, price text, active flag).
- Requests: review pending requests, view uploaded receipts, approve, reject or confirm payment, with optional admin notes.
- Linked accounts: each Ocserv user detail page lists every Telegram chat linked to that account, with a one-click unlink action.
- Custom Telegram copy & bot metadata: see docs/telegram-translations.md for
TELEGRAM_I18N_PATH(API messages),TELEGRAM_BOT_I18N_PATH(directory of bot UI*.jsonlocale files), andTELEGRAM_BOT_METADATA_LOCALES_PATH(BotFather descriptions).
- Branch name: legacy
- Old version: Developed using Python backend with Vue 2 frontend.
- Features: Minimal, limited functionality compared to the current version — only basic user and group management existed.
-
Docker-based:
-
Systemd-based:
-
Supported Operating Systems:
-
Programming Language:
-
- Clone the repository:
git clone https://github.com/mmtaee/ocserv-dashboard.git
cd ocserv-dashboard
chmod +x install.sh
./install.shthen select an option to continue:
- Open your web browser.
- Navigate to
https://YOUR-DOMAIN-OR-IP:3443in the browser. - Complete the administrative setup wizard.
- Start managing users, groups, and VPN settings from the dashboard.
- Open your web browser.
- Navigate to
https://YOUR-DOMAIN-OR-IP:3443/summary/in the browser. - Enter your Ocserv username and password to see insights.
The dashboard ships with an integrated Telegram bot service (telegram_bot) that runs alongside api, log_stream and user_expiry. Configuration lives entirely in the database — there is no need to edit .env or restart anything manually after a token change.
- Create a new bot with @BotFather and copy the token.
- Open the dashboard, navigate to Telegram → Settings and paste the token, set your admin chat ID, low-quota threshold, default language and the Ocserv host that customers will see when they receive new credentials.
- Toggle Bot enabled on and save. Within ~30 seconds the bot service detects the change, connects to Telegram and starts polling for updates.
- Define one or more sellable plans in Telegram → Packages.
- Send
/startto your bot in Telegram. Customer flows (link account / view usage / order new / renew / upload receipt) are now active. - Incoming requests appear in real time under Telegram → Requests where you approve them, review uploaded receipts and confirm payment. The bot delivers the resulting credentials (or renewal confirmation) automatically.
Receipt photos uploaded by customers are stored under /opt/ocserv_dashboard/uploads/receipts/ (created by the installer with 0750 permissions).
- Designed with best practices for security to ensure a safe and reliable VPN environment.
- The web panel is intuitive and easy to use for both administrators and end users.
- Scalable architecture allows efficient management of multiple users and groups.
- Real-time usage tracking and monitoring built-in.
- If you encounter any issues, please refer to the documentation or contact support.
The planned features and upcoming improvements are tracked in the TODO.md file.
Check it out to see what's coming next!
We welcome community contributions to improve and expand internationalization (i18n) support!
All web dashboard translation files are located at:
Each language has its own JSON file (e.g., en.json, it.json, zh.json, ru.json, etc.).
- Go to the locales directory.
- Choose an existing language file to improve, or create a new
<lang>.jsonfile for a new language. - Add all required translation keys with proper JSON structure.
- Make sure the JSON syntax is valid.
After adding a new <lang>.json file, you must update the install.sh file:
Open 👉 install.sh
Find the line that defines supported languages, and add your new language in the same format, comma-separated.
Example (adding Spanish):
LANGUAGES=en:English,it:Italiano,zh-tw:中文(繁體),zh-cn:中文(简体),ru:Русский,fa:فارسی,ar:العربية,es:Español
Contributing translations and updating the installer helps ensure the dashboard supports users around the world.
This project is licensed under the MIT License — see the LICENSE file for details.