OpenVK

Русский

OpenVK is an attempt to create a simple CMS that cosplays imitates old VKontakte. Code provided here is not stable yet.

Warning

OpenVK it is fan project, not affiliated in any way with VKontakte and it's company VK LLC. Below is the same message in Russian.
OpenVK является любительской разработкой и никак не связан с ВКонтакте и компанией ООО "ВК".

To be honest, we don't know whether if 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 OpenVK 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 (use git pull to update)
• Grab a prebuilt OpenVK distro from GitHub artifacts

Instances

A list of instances can be found in our wiki of this repository.

Can I create my own OpenVK instance?

Yes! And you are very welcome to.

However, OVK requires extensions, that may not always be available on web hostings (namely, sodium and yaml. these extensions are available on most of ISPManager hostings). That's why it is recommended to host your instances on VPS/VDS or dedicated servers.

If you want, you can add your instance to the list above so that people can register there.

System requirements

Here is our minimum hardware recommendation:

• CPU: Any dual-core 1GHz+ CPU or more powerful
• RAM: At least 2GB RAM (we recommend 6GB or 8GB for OpenVK with Redis)
• Minimum database space: 10GB

Looking for Docker or Kubernetes deployment?

See install/automated/docker/README.md and install/automated/kubernetes/README.md for Docker and Kubernetes deployment instructions.

Installation procedure

1. Install PHP 8.2 or later, web-server, Composer, and NPM.

2. Install MySQL-compatible database.

• We recommend using MariaDB or Percona Server, but any MySQL-compatible server should work too.
• Server should be compatible with at least MySQL 5.6, MySQL 8.0+ is recommended.
• Support for MySQL 4.1+ is WIP, replace utf8mb4 and utf8mb4_unicode_520_ci with utf8 and utf8_unicode_ci in SQLs.

3. Clone OpenVK:

git clone https://github.com/openvk/openvk /opt/openvk

4. Install dependencies:

cd /opt/openvk && composer install
cd Web/static/js && npm install

5. Configure your database: you need 2 databases — one for the main data, another for events.

6. Copy openvk-example.yml to openvk.yml and edit to your liking.

7. Run database migrations:

cd /opt/openvk && ./openvkctl upgrade

8. Point your web server to openvk/htdocs.

• Example config for nginx is available here. Make sure that root is set to /opt/openvk/htdocs (or wherever you installed OpenVK).

Once you are done, you can login in a default system administrator account on the site itself (no registration required):

• Login: admin@localhost.localdomain6
• Password: admin
  • It is recommended to change the password of the default account or disable it.

Warning

OpenVK installation procedure has been changed after code restructurisation. Now you don't need to install Chandler separately and install OpenVK as its extension.

If you are migrating from the old structure, make a backup of your Chandler+OpenVK installation, do a git pull, and consult the migration script: php bin/upgrade-structure.php --help. (When running the upgrade, it is recommended to use --extract flag, to move openvk dir out of Chandler's folder).

After the migration, do not forget to change webserver's DocumentRoot from Chandler's htdocs to OpenVK's htdocs.

Auto-install script

You can also use auto-install script for FreeBSD 15:

pkg install wget
wget https://github.com/OpenVK/openvk/raw/refs/heads/master/install/automated/freebsd-15/install
chmod +x install
./install

Real-time notifs

You can install Redis to take advantage of real-time notifications (if you enabled Event DB in config).

1. Install Redis from your beloved package manager in your OS
2. Set notificationsBroker under credentials to true

It should work out of box. If not, tweak Redis and OpenVK config settings

Warning

Kafka in OpenVK was been deprecated since this commit and no longer used in OpenVK codebase. If you see any mention of Kafka in source code, config or documentation, you should know that this will not work at all.

If my website uses OpenVK, should I release its 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 are planning to redistribute this, then you should license it under terms of any LGPL-compatible license (like OSL, GPL, LGPL etc).

Localization

Want to translate our project to your native language? You can try either:

• Weblate (simple way)
• Send Pull Request to us (hard way)

Localization is located in "locales" repository. List of languages is maintained in list.yml file, and the languages itself are in iOS String format.

Where can I get assistance?

You may reach out to us via:

• Bug Tracker
• GitHub Discussions
• Ticketing System
• Discord Server
• Telegram Chat: Go to our channel and open discussion in our channel menu.
• Matrix Chat: #openvk:matrix.org

Attention: bug tracker, board, Telegram, Discord and Matrix chat are public places, ticketing system is being served by volunteers. If you need to report something that should not be immediately disclosed to general public (for instance, a vulnerability), please contact us directly via this email: contact [at] openvk [dot] org