Skip to content
Get packs

Guide · Open source

How to use SSPanel-UIM: requirements, install and setup

Updated · written with AI from the project's own documentation and checked against our catalogue data

SSPanel-UIM is a web-based management system written in PHP for running a proxy service for other people. It handles user management, node management, a financial and payment system, and subscription links for Shadowsocks 2022, V2Ray, Trojan and TUIC. This guide explains what you need before installing, the install step given in the project README, and what the panel covers, so you can decide whether it fits your setup.

SSPanel UIMAnankke/SSPanel-UIM · ★ 10.4k · MIT

Quick start

  1. 1Confirm your server meets the requirements. Check that you have Debian 11+ (Debian 12 recommended), PHP 8.2+, Nginx with HTTPS, MariaDB 10.11+ or MySQL 8.0+, and Redis 7.0+.
  2. 2Install Git and Composer. The README lists Git and Composer as other requirements. Install both before cloning the project.
  3. 3Clone the repository. Run git clone https://github.com/Anankke/SSPanel-UIM.git on the server.
  4. 4Read the install guide. Follow the installation steps at docs.sspanel.io, which the README points to for full setup.
  5. 5Configure the database. Use MariaDB 10.11+ or MySQL 8.0+ and disable strict mode, as the README requires.
  6. 6Set up HTTPS and cron. Serve the panel through Nginx with HTTPS, then set up the single cron command the panel uses for its scheduled tasks, as described in the documentation.

Check whether SSPanel-UIM fits your use case

SSPanel-UIM is server-side management software. It is meant for operators who run proxy services for other users and want a web dashboard, plus built-in billing for a subscription service. It is not a personal proxy client.

  • Good fit: operators managing proxy users and nodes from a web dashboard
  • Good fit: subscription-based services that need billing
  • Poor fit: people who only want a personal proxy client
  • Poor fit: anyone without Linux server administration experience

Meet the system requirements

The README lists minimum and recommended hardware, plus a software stack. Debian 12 is recommended, and Debian 11 is the minimum OS listed.

  • Minimum: 1 CPU core, 1GB RAM, 10GB storage, Debian 11+
  • Recommended: 2 CPU cores or more, 2GB RAM or more, 20GB SSD, Debian 12
  • Web server: Nginx with HTTPS (HTTPS is required)
  • PHP 8.2+, with OPcache and JIT highly recommended
  • Database: MariaDB 10.11+ or MySQL 8.0+, with strict mode disabled
  • Cache: Redis 7.0+
  • Other: Git and Composer

Clone the repository

The README gives git clone as the first install step. Run it on your server, in the directory where you want the project to live.

git clone https://github.com/Anankke/SSPanel-UIM.git

Find the full installation guide

The README does not contain a complete install walkthrough. It points to the external documentation site at docs.sspanel.io for installation and usage details. Read that guide before you configure Nginx, PHP, the database and Redis, since the README only lists the components and says HTTPS is required.

The project also has a Telegram channel, a Telegram group and GitHub Discussions for questions, linked from the README.

  • Documentation: docs.sspanel.io
  • Telegram channel: @sspanel_Uim
  • Telegram group: @SSUnion
  • GitHub Discussions: Anankke/SSPanel-UIM/discussions

Know what the panel manages

According to the README, SSPanel-UIM covers user management, node management, traffic statistics and a payment system. Its subscription interface can output json, clash, sip008 and sing-box formats. A cron system runs all scheduled tasks through one command, and mail is sent through a built-in queue.

  • Payment gateways listed: Alipay F2F, PayPal, Stripe, Cryptomus
  • Billing modes listed: annual/monthly, pay-as-you-go, access type billing
  • Notifications: email queue, Telegram, Discord and Slack bot integration
  • Interface: Tabler theme on Bootstrap 5, responsive design

Plan for security before going live

Because the panel handles accounts and payments, treat the server as production infrastructure. The README requires HTTPS on Nginx. For security issues, the README asks you to email anankke@pm.me rather than open a public issue.

  • Serve the panel only over HTTPS
  • Keep PHP, MariaDB or MySQL, and Redis updated
  • Report vulnerabilities privately to anankke@pm.me

What people use it for

  • Running a subscription proxy service with user accounts and traffic statistics
  • Offering users subscription links in json, clash, sip008 or sing-box formats
  • Taking payments through supported gateways such as Stripe or PayPal
  • Sending account notifications through email, Telegram, Discord or Slack

Frequently asked questions

Is SSPanel-UIM free?

SSPanel-UIM is released under the MIT licence, as stated in the README and the LICENSE file. The MIT licence allows use and modification, but the README does not list any paid tiers, so check the licence text for your own obligations.

What operating system does SSPanel-UIM need?

The README lists Debian 11 as the minimum and recommends Debian 12. It does not list other operating systems.

What are the requirements for SSPanel-UIM?

You need PHP 8.2+, Nginx with HTTPS, MariaDB 10.11+ or MySQL 8.0+ with strict mode disabled, Redis 7.0+, Git and Composer. The recommended hardware is 2 CPU cores, 2GB RAM and 20GB SSD.

Where is the SSPanel-UIM installation guide?

The README points to the external documentation site at docs.sspanel.io for complete installation and usage instructions. The README itself only gives the git clone command.

What is SSPanel-UIM used for?

It is a multi-purpose proxy service management system for operators. It manages users, nodes, payments and subscription links for Shadowsocks 2022, V2Ray, Trojan and TUIC.

What are the alternatives to SSPanel-UIM?

Projects often compared with it include V2Board, XrayR and Marzban. Choose based on your billing needs, protocols and how much server administration you can handle.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

SSPanel-UIM suits operators who run a subscription proxy service and are comfortable administering a Linux server with Nginx, a database, Redis and PHP. It is not suitable for personal proxy use or for anyone new to server administration, because the README leaves most of the installation detail to an external documentation site.

Install options & downloads