Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Correction of remarks. #4

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions BETA_TEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- Следуйте инструкции по установке(1 и 2 часть)
- Откройте домен или порт SimpleCabinetWebAPI в браузере, откройте консоль разработчика и выполните в браузере запрос register по документации [Авторизация](https://github.com/SimpleCabinet/SimpleCabinetWebAPI/blob/main/API_DOCS.md#%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F)
- Авторизируйтесь в браузере для дальнейшего тестирования, вставив и выполнив в браузере запрос authorize [Авторизация](https://github.com/SimpleCabinet/SimpleCabinetWebAPI/blob/main/API_DOCS.md#%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F)
- Установите плагин Bukkit на тестовый сервер по инструкции, а так же все интересующие вас плагины
- Установите плагин Bukkit на тестовый сервер по инструкции, а также все интересующие вас плагины
- Подключите LuckPerms к базе данных SimpleCabinet 2
- Создайте тестовую группу с помощью запросов из раздела [Магазин привилегий](https://github.com/SimpleCabinet/SimpleCabinetWebAPI/blob/main/API_DOCS.md#%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F)
- Купите тестовую группу и убедитесь, что покупка выдана корректно
Expand All @@ -24,5 +24,5 @@
- Если вы уверены в том, что наблюдаемое поведение баг и вы готовы подробно расписать как этот баг воспроизвести вы можете сразу создать Issue в соответствующем репозитории
- Если вы не уверены, или вам нужна помощь в исследовании бага обратитесь в Discord GravitLauncher с упоминанием меня(Gravita)
#### Frontend
Пока оффициальный frontend для SimpleCabinet 2 в разработке вы можете написать или заказать рабоработку своего frontend'а по [открытой документации](https://github.com/SimpleCabinet/SimpleCabinetWebAPI/blob/main/API_DOCS.md)
Пока официальный frontend для SimpleCabinet 2 в разработке вы можете написать или заказать разработку своего frontend'а по [открытой документации](https://github.com/SimpleCabinet/SimpleCabinetWebAPI/blob/main/API_DOCS.md)
Если при разработке возникли какие то проблемы, связанные с недостаточной гибкостью API сообщите об этом мне в Discord(Gravita)
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@
- GravitLauncher 5.2.11 и выше
- Java 17 и выше
- PostgreSQL в качестве основной базы данных
- Миграция: любая CMS с базой данных MySQL/MariaDB и одним из поддержиываемых алгоритмов хеширования пароля: BCRYPT, DOUBLEMD5, MD5, SHA256, AUTHMESHA256, PHPASS
- Миграция: любая CMS с базой данных MySQL/MariaDB и одним из поддерживаемых алгоритмов хеширования пароля: BCRYPT, DOUBLEMD5, MD5, SHA256, AUTHMESHA256, PHPASS
- Выдача привилегий: LuckPerms
- Выдача предметов: сервер на Sponge или Bukkit
# FAQ
- **Почему SimpleCabinet 2 не поддерживает MySQL?**
- Простота установки: выбор PostgreSQL делает установку проще, понятнее и прямолинейнее
- Оптимизация: PostgreSQL имеет множество функций, которых нет в большистве популярных версий MySQL. Некоторые функции отсутствуют в MySQL вовсе
- Оптимизация: PostgreSQL имеет множество функций, которых нет в большинстве популярных версий MySQL. Некоторые функции отсутствуют в MySQL вовсе
- Обновление до новых версий: обновление БД теперь более предсказуемо и не требует ручных действий
- **У меня есть плагины, которые работают только с MySQL. Что делать?**
- Вы по прежнему можете пользоватся плагинами, работающими только с MySQL. Функционал экономики и магазина блоков и привилегий предоставляет SimpleCabinet, а для прав используется LuckPerms который поддерживает PostgreSQL
- Вы по прежнему можете пользоваться плагинами, работающими только с MySQL. Функционал экономики и магазина блоков и привилегий предоставляет SimpleCabinet, а для прав используется LuckPerms который поддерживает PostgreSQL
- **Как обновится с SimpleCabinet 1**
- Вам понадобится установить лаунчсервер версии 5.1.10 и **последний** модуль SimpleCabinet 1. После чего вы должны ввести команду `cabinet upgrade2` **после** установки web части SimpleCabinet 2. Пользователи будут перенесены в новую БД
# Установка PostgreSQL
Expand Down Expand Up @@ -82,7 +82,7 @@ host all all ::1/128 trust
- Администратор может вручную или с помощью скриптов и плагинов добавлять, удалять и менять курсы валют
- Плагин на стороне сервера может инициировать любую операцию с валютами(пополнение/снятие/перевод)
- В системе может быть сколько угодно валют и курсов между ними
- Курсы может "Валюта 1 -> Валюта 2" и "Валюта 2 -> Валюта 1" могут отличатся. Могут существовать курсы только в одном направлении
- Курсы может "Валюта 1 -> Валюта 2" и "Валюта 2 -> Валюта 1" могут отличаться. Могут существовать курсы только в одном направлении
- Курс "Валюта 1 -> Валюта 1" имеет особое значение - разрешает переводы в этой валюте между игроками
- Алгоритм проверит можно ли "дюпнуть" монеты путем переводов между валютами, и если такое возможно заблокирует изменение курса
- Все транзакции(пополнение, снятие, переводы) логгируются в таблице транзакций.
Expand Down
6 changes: 3 additions & 3 deletions RESALE_README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Памятка жадным разработчикам форков(реселлерам) и покупателям их труда
**SimpleCabinet 2** является уникальным продуктом, оригинал которого находится здесь и только здесь, распространяется бесплатно и с открытым исходным кодом. Все приватные, закрытые, "улучшенные" версии являются плодом работы сторонних разработчиков, никак не связанных с нами.
Мы принимаем Pull Request и рады видеть реализацию каких либо дополнительных фитч, если они действительно полезны. Вместо того, что бы продавать реализацию какой либо фитчи - подумайте, а не проще ли было поучавствовать в opensource и предложить свою релаизацию в PR.
Мы принимаем Pull Request и рады видеть реализацию каких либо дополнительных фитч, если они действительно полезны. Вместо того, чтобы продавать реализацию какой либо фитчи - подумайте, а не проще ли было поучаствовать в opensource и предложить свою релаизацию в PR.
## Покупателям
- Архиткетура SimpleCabinet 2 устроена таким образом, что допустить SQL Injection, XSS, CSRF и прочие классические дыры в безопасности **невозможно**. Если вам продают "фиксы" SimpleCabinet 2 без дополнительных фитч - вас обманывают.
- Архитектура SimpleCabinet 2 устроена таким образом, что допустить SQL Injection, XSS, CSRF и прочие классические дыры в безопасности **невозможно**. Если вам продают "фиксы" SimpleCabinet 2 без дополнительных фитч - вас обманывают.
- С осторожностью относитесь к отсутствию исходников. Покупая какую либо часть от стороннего разработчика вы не сможете узнать изменения, которые были произведены(diff)
- С большой осторожностью относитесь к обфусцированным файлам. Вы не сможете узнать что именно в них находится и какие были изменения. А раз они обфусцированны - значит что то хотели от вас скрыть.
- С большой осторожностью относитесь к обфусцированным файлам. Вы не сможете узнать что именно в них находится и какие были изменения. А раз они обфусцированы - значит что то хотели от вас скрыть.
## Жадным разработчикам форков(реселлерам)
- При разработке старайтесь придерживаться тех API, которые являются безопасными и переносимыми. Например, использование JPA, EntityManager, HQL, Criteria API безопасно и не зависит от БД, а сырые SQL запросы - нет.
- Старайтесь выдавать покупателям исходники, что бы они могли обновлять и комбинировать ваши наработки с другими
Expand Down