Lanmikeman/openvk
Lanmikeman/openvk
1
1
Fork 0
mirror of https://github.com/openvk/openvk synced 2024-12-23 00:51:03 +03:00
Code Issues Projects Releases Packages Wiki Activity
Not-yet-federated open source social network inspired by VK.
1456 commits 45 branches 4 tags 31 MiB
PHP 59.1%
JavaScript 29.6%
CSS 8%
Latte 2.5%
Shell 0.4%
Other 0.4%
Find a file
celestora 089c805038 Merge branch 'textarea-refactor' of https://github.com/openvk/openvk into textarea-refactor
2023-01-21 15:00:35 +02:00
.github Add an action for proper repository mirroring 2023-01-13 08:50:45 +07:00
.idea Now only unnecessary PhpStorm files are removed👉🏻👈🏻 2022-09-08 00:22:15 +03:00
CLI Coin: Add ability to see how much voices you reveiced trough notifications 2022-06-02 14:07:31 +03:00
data Locales: learn_more 2022-12-18 13:25:52 +07:00
Email Users: Add ability to change email address in settings 2022-05-06 16:17:08 +02:00
install Global: Implement showing platform 2022-12-17 02:03:02 +03:00
locales Locale: Revert stupid ru locale changes 2023-01-11 13:48:51 +03:00
misc Initial commit 2020-06-07 19:04:43 +03:00
ServiceAPI фикс дюпа алмазов в служебном апи) 2022-11-14 16:22:23 +02:00
storage Fix missing dirs 2020-06-07 21:36:55 +03:00
themepacks OpenVK Midnight: forgot about that 2022-12-30 14:44:28 +07:00
tmp/api-storage Add photos.save, photos.saveWallPhoto, photos.saveOwnerPhoto, photos.getUploadServer 2022-03-29 20:43:34 +03:00
VKAPI VKAPI: Wall.get now require user 2022-12-22 01:05:49 +03:00
Web Merge branch 'textarea-refactor' of https://github.com/openvk/openvk into textarea-refactor 2023-01-21 15:00:35 +02:00
.gitignore CI for OpenVK, Kubernetes and Docker deployments (#735) 2022-10-30 14:44:14 +03:00
bootstrap.php Adds PHP 8.1 compatability (#671) 2022-08-19 20:22:32 +03:00
CODE_OF_CONFLICT.md Rename CoC and CS files 2022-05-23 16:25:27 +03:00
CODE_STYLE.md Rename CoC and CS files 2022-05-23 16:25:27 +03:00
composer.json Adds PHP 8.1 compatability (#671) 2022-08-19 20:22:32 +03:00
COPYING Change license to less restrictive LGPLv2.1 2020-06-14 19:56:16 +03:00
crowdin.yml Update Crowdin configuration file 2021-09-13 19:17:49 +03:00
manifest.yml Global: Get rid of OpenVK 2 branding (#105) 2021-10-31 18:29:52 +07:00
openvk-example.yml Experiment(Photo): add "quick" image saving method to increase teh upload speedz 2022-12-14 22:15:29 +02:00
openvkctl Coin: A very early implementation of Toncoin fetching 2022-05-07 02:33:22 +03:00
quirks.yml Add polls (#743) 2022-10-11 19:04:43 +03:00
README.md CI for OpenVK, Kubernetes and Docker deployments (#735) 2022-10-30 14:44:14 +03:00
README_RU.md CI for OpenVK, Kubernetes and Docker deployments (#735) 2022-10-30 14:44:14 +03:00
Vagrantfile Update vagrantfile (i'm still not sure it works) 2022-04-10 18:15:19 +03:00

README.md

openvkOpenVK

Русский

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 (use git pull to update)
  • Grab a prebuilt OpenVK distro from GitHub artifacts

Instances

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

  1. Install PHP 7.4, web-server, Composer, Node.js, Yarn and Chandler
  • PHP 8.1 is supported, but it was not tested carefully, be aware of that.
  1. 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 and utf8mb4_unicode_520_ci with utf8 and utf8_unicode_ci in SQLs.
  1. 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
  1. 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/
  1. 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
  2. Import install/init-event-db.sql to a separate database (Yandex.Clickhouse can also be used, highly recommended)
  3. Copy openvk-example.yml to openvk.yml and change options to your liking
  4. Run composer install in OpenVK directory
  5. Run composer install in commitcaptcha directory
  6. Move to Web/static/js and execute yarn install
  7. Set openvk as your root app in chandler.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).

Looking for Docker or Kubernetes deployment?

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

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:

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

Get it on Codeberg