Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/localzet-dev/shadowsocks-manager-php
Shadowsocks-Manager-PHP is a tool for managing Shadowsocks servers, designed to simplify server administration and improve user experience. It provides features for multi-user management, traffic control, and easy configuration.
https://github.com/localzet-dev/shadowsocks-manager-php
manager php server shadowsocks
Last synced: 29 days ago
JSON representation
Shadowsocks-Manager-PHP is a tool for managing Shadowsocks servers, designed to simplify server administration and improve user experience. It provides features for multi-user management, traffic control, and easy configuration.
- Host: GitHub
- URL: https://github.com/localzet-dev/shadowsocks-manager-php
- Owner: localzet-dev
- License: agpl-3.0
- Created: 2024-06-03T15:01:26.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-27T18:21:47.000Z (6 months ago)
- Last Synced: 2024-11-24T20:10:56.935Z (29 days ago)
- Topics: manager, php, server, shadowsocks
- Language: PHP
- Homepage: https://localzet.github.io/Shadowsocks-Manager-PHP/
- Size: 29.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: support/Request.php
Awesome Lists containing this project
README
# SSManager-S
SSManager-S - это мощный и гибкий инструмент для управления серверами, построенный на базе Triangle-org/Web и работающий на базе localzet/server. Он предоставляет удобный и безопасный доступ к API с использованием токенов localzet/lwt, обеспечивая высокую производительность и надежность.
## Установка
### Установка Redis
Redis используется для кэширования данных. Для установки выполните следующие команды:
```bash
sudo apt update
sudo apt install redis-server
```
Проверьте статус Redis:
```bash
sudo systemctl status redis
```
### Установка Supervisor
Supervisor используется для автозапуска процессов. Для установки выполните следующие команды:
```bash
sudo apt-get install supervisor
sudo service supervisor restart
```
## Настройка проекта
### Вариант 1: Установка через Composer
Если в вашей системе уже установлены PHP v8.3 и Composer, вы можете использовать Composer для установки проекта:
1. Создание проекта
```bash
composer create-project localzet/ssmgr
```
2. Переход в папку проекта
```bash
cd ssmgr
```
3. Установка зависимостей
```bash
composer install
```
4. Инициализация master
```bash
php master init
```
5. Включение master
```bash
php master enable
```
### Вариант 2: Клонирование репозитория
1. Клонирование репозитория
```bash
git clone
```
2. Переход в папку репозитория
```bash
cd <имя репозитория>
```
3. Установка прав на исполнение для php-8.3
```bash
chmod +x ./php-8.3
```
4. Установка зависимостей с помощью Composer
```bash
./php-8.3 composer.phar install
```
5. Инициализация master
```bash
./php-8.3 master init
```
6. Включение master
```bash
./php-8.3 master enable
```
## Использование API
По умолчанию для доступа к API требуются токены `localzet/lwt`, разделенные на сегменты:
- `header` в заголовке `X-LWT-Header`
- `payload` в POST-параметре `data`
- `signature` в заголовке `X-LWT-Signature`
Ключи для LWT будут находиться в директории `./runtime/keys` после команды `init`
Если вы по какой-то причине не можете использовать LWT - отключить их использование можно переменной `LWT_ENABLE` в файле `.env`
### Конечные точки
| PATH | METHOD | METHOD |
|------------|--------|--------|
| /user | GET | GET |
| /user | POST | POST |
| /user/{id} | GET | GET |
| /user/{id} | PUT | PUT |
| /user/{id} | DELETE | DELETE |
| /flow | GET | GET |
| /version | GET | {"version": "v4.2.11", "isGfw": true} |