https://github.com/apostoldevel/apostol-thanks
Donate Диджитализируй
https://github.com/apostoldevel/apostol-thanks
Last synced: 4 months ago
JSON representation
Donate Диджитализируй
- Host: GitHub
- URL: https://github.com/apostoldevel/apostol-thanks
- Owner: apostoldevel
- License: mit
- Created: 2022-05-26T18:24:08.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-19T17:09:47.000Z (over 2 years ago)
- Last Synced: 2025-01-13T15:50:24.578Z (5 months ago)
- Language: PLpgSQL
- Size: 6.18 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# THNX
**THNX** - Спасибо. Система донатов для авторов.
ОПИСАНИЕ
-
**THNX** - это серверная часть [пет проекта](https://github.com/alexey-goloburdin/thanks) [Алексея Голобурдина](https://www.youtube.com/c/%D0%94%D0%B8%D0%B4%D0%B6%D0%B8%D1%82%D0%B0%D0%BB%D0%B8%D0%B7%D0%B8%D1%80%D1%83%D0%B9).
Реализовано на базе [Апостол CRM](https://github.com/apostoldevel/apostol-crm).
API
-
Мы используем OpenAPI для взаимодействия с Система донатов (THNX). Вы можете напрямую открыть пользовательский интерфейс Swagger через [http://donate-system.ru/docs](http://donate-system.ru/docs/).
Кроме того, вы можете использовать любой клиент OpenAPI для импорта файла [api.yaml](https://github.com/apostoldevel/apostol-thanks/blob/master/www/docs/api.yaml) из нашего репозитория (скачать).
Документация к [REST API](https://github.com/apostoldevel/module-AppServer#rest-api) платформы [Апостол CRM](https://github.com/apostoldevel/apostol-crm).
Документация к [WebSocket API](https://github.com/apostoldevel/module-WebSocketAPI#websocket-api) платформы [Апостол CRM](https://github.com/apostoldevel/apostol-crm).
Docker
-
Вы можете собрать образ самостоятельно или получить уже готовый из докер-хаб:
### Собрать
~~~
docker build -t thnx .
~~~
### Получить
~~~
docker pull apostoldevel/thnx
~~~
### Запустить
Если собрали самомтоятельно:
~~~
docker run -d -p 8080:8080 --rm --name thnx thnx
~~~
Если получили готовый образ:
~~~
docker run -d -p 8080:8080 --rm --name thnx apostoldevel/thnx
~~~
Swagger UI будет доступен по адресу [http://localhost:8080/docs/](http://localhost:8080/docs/) или http://host-ip:8080/docs/ в вашем браузере.
СБОРКА И УСТАНОВКА
-
Для сборки проекта Вам потребуется:
1. Компилятор C++;
1. [CMake](https://cmake.org) или интегрированная среда разработки (IDE) с поддержкой [CMake](https://cmake.org);
1. Библиотека [libpq-dev](https://www.postgresql.org/download) (libraries and headers for C language frontend development);
1. Библиотека [postgresql-server-dev-all](https://www.postgresql.org/download) (libraries and headers for C language backend development).
### Linux (Debian/Ubuntu)
Для того чтобы установить компилятор C++ и необходимые библиотеки на Ubuntu выполните:
~~~
sudo apt-get install build-essential libssl-dev libcurl4-openssl-dev make cmake gcc g++
~~~
###### Подробное описание установки C++, CMake, IDE и иных компонентов необходимых для сборки проекта не входит в данное руководство.
#### PostgreSQL
Для того чтобы установить PostgreSQL воспользуйтесь инструкцией по [этой](https://www.postgresql.org/download/) ссылке.
#### База данных
Для того чтобы установить базу данных необходимо выполнить:
1. Прописать наименование базы данных в файле db/sql/sets.conf (по умолчанию: `thanks`)
1. Прописать пароли для пользователей СУБД [libpq-pgpass](https://postgrespro.ru/docs/postgrespro/14/libpq-pgpass):
~~~
$ sudo -iu postgres -H vim .pgpass
~~~
~~~
*:*:*:kernel:kernel
*:*:*:admin:admin
*:*:*:daemon:daemon
~~~
1. Указать в файле настроек /etc/postgresql/{version}/main/postgresql.conf:
Пути поиска схемы kernel:
~~~
search_path = '"$user", kernel, public' # schema names
~~~
1. Указать в файле настроек /etc/postgresql/{version}/main/pg_hba.conf:
~~~
# TYPE DATABASE USER ADDRESS METHOD
local all kernel md5
local all admin md5
local all daemon md5
host all kernel 127.0.0.1/32 md5
host all admin 127.0.0.1/32 md5
host all daemon 127.0.0.1/32 md5
~~~
1. Выполнить:
~~~
$ cd db/
$ ./install.sh --make
~~~
###### Параметр `--make` необходим для установки базы данных в первый раз. Далее установочный скрипт можно запускать или без параметров или с параметром `--install`.
##### Для сборки **THNX**, с помощью Git выполните:
~~~
git clone https://github.com/apostoldevel/apostol-thanks.git
~~~
Далее:
1. Настроить `CMakeLists.txt` (по необходимости);
1. Собрать и скомпилировать (см. ниже).
##### Для того чтобы установить **THNX** (без Git) необходимо:
1. Скачать **THNX** по [ссылке](https://github.com/apostoldevel/apostol-thanks/archive/master.zip);
1. Распаковать;
1. Настроить `CMakeLists.txt` (по необходимости);
1. Собрать и скомпилировать (см. ниже).
###### Сборка:
~~~
cd apostol-thanks
./configure
~~~
###### Компиляция и установка:
~~~
cd cmake-build-release
make
sudo make install
~~~
По умолчанию бинарный файл `thnx` будет установлен в:
~~~
/usr/sbin
~~~
Файл конфигурации и необходимые для работы файлы, в зависимости от варианта установки, будут расположены в:
~~~
/etc/thnx
или
~/thnx
~~~
ЗАПУСК
-
###### Если `INSTALL_AS_ROOT` установлено в `ON`.
**`thnx`** - это системная служба (демон) Linux.
Для управления **`thnx`** используйте стандартные команды управления службами.
Для запуска `thnx` выполните:
~~~
sudo systemctl start thnx
~~~
Для проверки статуса выполните:
~~~
sudo systemctl status thnx
~~~
Результат должен быть **примерно** таким:
~~~
● thnx.service - THNX - Donate System
Loaded: loaded (/etc/systemd/system/thnx.service; enabled; vendor preset: enabled)
Active: active (running) since Fri 2022-05-27 13:41:41 MSK; 55s ago
Process: 420387 ExecStartPre=/usr/bin/rm -f /run/thnx.pid (code=exited, status=0/SUCCESS)
Process: 420388 ExecStartPre=/usr/sbin/thnx -t (code=exited, status=0/SUCCESS)
Process: 420389 ExecStart=/usr/sbin/thnx (code=exited, status=0/SUCCESS)
Main PID: 420390 (thnx)
Tasks: 5 (limit: 2364)
Memory: 5.8M
CPU: 579ms
CGroup: /system.slice/thnx.service
├─420390 thnx: master process /usr/sbin/thnx
├─420391 thnx: worker process ("websocket api", "application server", "authorization server", "web server")
├─420392 thnx: helper process ("pg fetch")
├─420393 thnx: message server
└─420394 thnx: task scheduler
~~~
### **Управление**.
Управлять **`thnx`** можно с помощью сигналов.
Номер главного процесса по умолчанию записывается в файл `/run/thnx.pid`.
Изменить имя этого файла можно при конфигурации сборки или же в `thnx.conf` секция `[daemon]` ключ `pid`.
Главный процесс поддерживает следующие сигналы:
|Сигнал |Действие |
|---------|------------------|
|TERM, INT|быстрое завершение|
|QUIT |плавное завершение|
|HUP |изменение конфигурации, запуск новых рабочих процессов с новой конфигурацией, плавное завершение старых рабочих процессов|
|WINCH |плавное завершение рабочих процессов|
Управлять рабочими процессами по отдельности не нужно. Тем не менее, они тоже поддерживают некоторые сигналы:
|Сигнал |Действие |
|---------|------------------|
|TERM, INT|быстрое завершение|
|QUIT |плавное завершение|