84635a22ba
slowly getting back on "business"... Resolves #584 |
||
---|---|---|
.github | ||
.idea | ||
CLI | ||
data | ||
install | ||
locales | ||
misc | ||
ServiceAPI | ||
storage | ||
themepacks | ||
tmp/api-storage | ||
VKAPI | ||
Web | ||
.gitignore | ||
bootstrap.php | ||
CODE_OF_CONFLICT.md | ||
CODE_STYLE.md | ||
composer.json | ||
composer.lock | ||
COPYING | ||
crowdin.yml | ||
docker-compose.yml | ||
Dockerfile | ||
manifest.yml | ||
openvk-example.yml | ||
openvkctl | ||
quirks.yml | ||
README.md | ||
README_RU.md | ||
Vagrantfile |
OpenVK
OpenVK is an attempt to create a simple CMS that cosplays imitates old VK. Code provided here is not stable yet.
VKontakte belongs to Pavel Durov and VK Group.
To be honest, we don't know whether it even works. However, this version is maintained and we will be happy to accept your bugreports in our bug-tracker. You should also be able to submit them using ticketing system (you will need an OVK account for this).
When's the release?
We will release OpenVK as soon as it's ready. As for now you can:
git clone
this repo's master branch (usegit pull
to update)- Grab a prebuilt OpenVK distro from GitHub artifacts
Instances
- openvk.su
- openvk.uk - official mirror of openvk.su (https://t.me/openvkch/1609)
- openvk.co - yet another official mirror of openvk.su without TLS (https://t.me/openvkch/1654)
- social.fetbuk.ru
- vepurovk.xyz
Can I create my own OpenVK instance?
Yes! And you're very welcome to.
However, OVK makes use of Chandler Application Server. This software requires extensions, that may not be provided by your hosting provider (namely, sodium and yaml. these extensions are available on most of ISPManager hostings).
If you want, you can add your instance to the list above so that people can register there.
Installation procedure
- Install PHP 7.4, web-server, Composer, Node.js, Yarn and Chandler
- PHP 8 has not yet been tested, so you should not expect it to work. (edit: it does not work).
- Install MySQL-compatible database.
- We recommend using Percona Server, but any MySQL-compatible server should work
- Server should be compatible with at least MySQL 5.6, MySQL 8.0+ recommended.
- Support for MySQL 4.1+ is WIP, replace
utf8mb4
andutf8mb4_unicode_520_ci
withutf8
andutf8_unicode_ci
in SQLs.
- Install commitcaptcha and OpenVK as Chandler extensions like this:
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
- And enable them:
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/
- Import
install/init-static-db.sql
to the same database you installed Chandler to and import all sqls frominstall/sqls
to the same database - Import
install/init-event-db.sql
to a separate database (Yandex.Clickhouse can also be used, highly recommended) - Copy
openvk-example.yml
toopenvk.yml
and change options to your liking - Run
composer install
in OpenVK directory - Run
composer install
in commitcaptcha directory - Move to
Web/static/js
and executeyarn install
- Set
openvk
as your root app inchandler.yml
Once you are done, you can login as a system administrator on the network itself (no registration required):
- Login:
admin@localhost.localdomain6
- Password:
admin
- It is recommended to change the password of the built-in account or disable it.
💡Confused? Full installation walkthrough is available here (CentOS 8 and family).
If my website uses OpenVK, should I release it's sources?
It depends. You can keep the sources to yourself if you do not plan to distribute your website binaries. If your website software must be distributed, it can stay non-OSS provided the OpenVK is not used as a primary application and is not modified. If you modified OpenVK for your needs or your work is based on it and you're planning to redistribute this, then you should license it under terms of any LGPL-compatible license (like OSL, GPL, LGPL etc).
Where can I get assistance?
You may reach out to us via:
- Bug-tracker
- Ticketing system
- Telegram chat: Go to our channel and open discussion in our channel menu.
- Discussions
- Matrix chat: #openvk:matrix.org
Attention: bug tracker, board, telegram and matrix chat are public places. And ticketing system is being served by volunteers. If you need to report something, that shouldn't be immediately disclosed to general public (for instance, vulnerability report), please use contact us directly at this email: openvk [at] tutanota [dot] com