diff --git a/README.md b/README.md index 9c1eb9d4..89c9cbb0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ To be honest, we don't know whether it even works. However, this version is main We will release OpenVK as soon as it's ready. As for now you can: * `git clone` this repo's master branch (use `git pull` to update) -* Grab a prebuilt OpenVK distro from [GitHub artifacts](https://github.com/openvk/archive/actions/workflows/nightly.yml) +* Grab a prebuilt OpenVK distro from [GitHub artifacts](https://nightly.link/openvk/archive/workflows/nightly/master/OpenVK%20Archive.zip) ## Instances @@ -55,7 +55,7 @@ ln -s /path/to/chandler/extensions/available/openvk /path/to/chandler/extensions ``` 5. Import `install/init-static-db.sql` to the **same database** you installed Chandler to and import all sqls from `install/sqls` to the **same database** -6. Import `install/init-event-db.sql` to a **separate database** (Yandex.Clickhouse can also be used, higly recommended) +6. Import `install/init-event-db.sql` to a **separate database** (Yandex.Clickhouse can also be used, highly recommended) 7. Copy `openvk-example.yml` to `openvk.yml` and change options to your liking 8. Run `composer install` in OpenVK directory 9. Run `composer install` in commitcaptcha directory diff --git a/README_RU.md b/README_RU.md index dda9e989..780f54a0 100644 --- a/README_RU.md +++ b/README_RU.md @@ -2,17 +2,17 @@ _[English](README.md)_ -**OpenVK** это попытка создать простую CMS, которая ~~косплеит~~ имитирует старый ВКонтакте. Представленный здесь код пока не стабилен. +**OpenVK** - это попытка создать простую CMS, которая ~~косплеит~~ имитирует старый ВКонтакте. На данный момент представленный здесь исходный код проекта пока не является стабильным. ВКонтакте принадлежит Павлу Дурову и VK Group. Честно говоря, мы даже не знаем, работает ли она вообще. Однако, эта версия поддерживается, и мы будем рады принять ваши сообщения об ошибках [в нашем баг-трекере](https://github.com/openvk/openvk/projects/1). Вы также можете отправлять их через [вкладку "Помощь"](https://openvk.su/support?act=new) (для этого вам понадобится учетная запись OVK). -## Когда релиз? +## Когда выйдет релизная версия? Мы выпустим OpenVK, как только он будет готов. На данный момент Вы можете: -* Сделать `git clone` master ветки этой репозитории (используйте `git pull` для обновления) -* Взять готовую сборку OpenVK из [GitHub Actions](https://github.com/openvk/archive/actions/workflows/nightly.yml) +* Склонировать master ветку репозитория командой `git clone` (используйте `git pull` для обновления) +* Взять готовую сборку OpenVK из [GitHub Actions](https://nightly.link/openvk/archive/workflows/nightly/master/OpenVK%20Archive.zip) ## Инстанции @@ -32,35 +32,41 @@ _[English](README.md)_ 1. Установите PHP 7.4, веб-сервер, Composer, Node.js, Yarn и [Chandler](https://github.com/openvk/chandler) -* PHP 8 еще **не** тестировался, поэтому не стоит ожидать, что он будет работать (обновление: он не работает). +* PHP 8 еще **не** тестировался, поэтому не стоит ожидать, что он будет работать (UPD: он не работает). -2. Установите [commitcaptcha](https://github.com/openvk/commitcaptcha) и OpenVK в качестве расширений Chandler следующим образом: +2. Установите MySQL-совместимую базу данных. + +* Мы рекомендуем использовать Persona Server, но любая MySQL-совместимая база данных должна работать +* Сервер должен поддерживать хотя бы MySQL 5.6, рекомендуется использовать MySQL 8.0+. +* Поддержка для MySQL 4.1+ находится в процессе, а пока замените `utf8mb4` и `utf8mb4_unicode_520_ci` на `utf8` и `utf8_unicode_ci` в SQL-файлах, соответственно. + +3. Установите [commitcaptcha](https://github.com/openvk/commitcaptcha) и OpenVK в качестве расширений Chandler: ```bash git clone https://github.com/openvk/openvk /path/to/chandler/extensions/available/openvk git clone https://github.com/openvk/commitcaptcha /path/to/chandler/extensions/available/commitcaptcha ``` -3. И включите их: +4. И включите их: ```bash ln -s /path/to/chandler/extensions/available/commitcaptcha /path/to/chandler/extensions/enabled/ ln -s /path/to/chandler/extensions/available/openvk /path/to/chandler/extensions/enabled/ ``` -4. Импортируйте `install/init-static-db.sql` в **ту же базу данных**, в которую вы установили Chandler, и импортируйте все SQL файлы из папки `install/sqls` в **ту же базу данных** -5. Импортируйте `install/init-event-db.sql` в **отдельную базу данных** (Яндекс.Clickhouse также может быть использован, настоятельно рекомендуется) -6. Скопируйте `openvk-example.yml` в `openvk.yml` и измените параметры -7. Запустите `composer install` в директории OpenVK -8. Запустите `composer install` в директории commitcaptcha -9. Перейдите в `Web/static/js` и выполните `yarn install` -10. Установите `openvk` в качестве корневого приложения в файле `chandler.yml` +5. Импортируйте `install/init-static-db.sql` в **ту же базу данных**, в которую вы установили Chandler, и импортируйте все SQL файлы из папки `install/sqls` в **ту же базу данных** +6. Импортируйте `install/init-event-db.sql` в **отдельную базу данных** (Яндекс.Clickhouse также может быть использован, настоятельно рекомендуется) +7. Скопируйте `openvk-example.yml` в `openvk.yml` и измените параметры под свои нужды +8. Запустите `composer install` в директории OpenVK +9. Запустите `composer install` в директории commitcaptcha +10. Перейдите в `Web/static/js` и выполните `yarn install` +11. Установите `openvk` в качестве корневого приложения в файле `chandler.yml` После этого вы можете войти как системный администратор в саму сеть (регистрация не требуется): * **Логин**: `admin@localhost.localdomain6` * **Пароль**: `admin` - * Перед использованием встроенной учетной записи рекомендуется сменить пароль. + * Перед использованием встроенной учетной записи рекомендуется сменить пароль или отключить её. 💡Запутались? Полное руководство по установке доступно [здесь](https://docs.openvk.su/openvk_engine/centos8_installation/) (CentOS 8 [и](https://almalinux.org/ru/) [семейство](https://yum.oracle.com/oracle-linux-isos.html)). @@ -82,5 +88,5 @@ ln -s /path/to/chandler/extensions/available/openvk /path/to/chandler/extensions **Внимание**: баг-трекер, форум, телеграм- и matrix-чат являются публичными местами, и жалобы в OVK обслуживается волонтерами. Если вам нужно сообщить о чем-то, что не должно быть раскрыто широкой публике (например, сообщение об уязвимости), пожалуйста, свяжитесь с нами напрямую по этому адресу: **openvk [собака] tutanota [точка] com**. - Получить на Codeberg + Get it on Codeberg