mirror of
https://github.com/openvk/openvk
synced 2024-11-11 01:19:53 +03:00
README: .textile -> .md + corrections
This commit is contained in:
Ilya Prokopenko
parent
8a94f2725a
commit
2085eee5ea
3 changed files with 74 additions and 99 deletions
27
INSTALL.md
27
INSTALL.md
|
|
@ -1,27 +0,0 @@
|
||||||
# OpenVK Installation Instructions
|
|
||||||
|
|
||||||
* * *
|
|
||||||
|
|
||||||
1. Install Composer, Node.js, Yarn and [Chandler](https://github.com/openvk/chandler)
|
|
||||||
2. Install [commitcaptcha](https://github.com/openvk/commitcaptcha)/[chandler-recaptcha](https://github.com/openvk/chandler-recaptcha) and OpenVK as Chandler extensions and enable them like this:
|
|
||||||
|
|
||||||
```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/
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Import install/init-static-db.sql to same database you installed Chandler to
|
|
||||||
4. Import install/init-event-db.sql to separate database
|
|
||||||
5. Rename openvk-example.yml to openvk.yml and change options
|
|
||||||
6. Run `composer install` in OpenVK directory
|
|
||||||
7. Move to Web/static/js and execute `yarn install`
|
|
||||||
8. 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 before using the built-in account.
|
|
||||||
|
|
||||||
Full example installation instruction for CentOS 8 is also available [here](docs/centos8_install.md).
|
|
||||||
74
README.md
Normal file
74
README.md
Normal file
|
|
@ -0,0 +1,74 @@
|
||||||
|
# <img align="right" src="https://github.com/openvk/openvk/raw/master/Web/static/img/logo_shadow.png" alt="openvk" title="openvk" width="15%">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 even know whether it even works. However, this version is maintained and we will be happy to accept your bugreports [in our bug-tracker](https://github.com/openvk/openvk/projects/1). You should also be able to submit them using [ticketing system](https://openvk.su/support?act=new) (you will need an OVK account for this).
|
||||||
|
|
||||||
|
## When's the release?
|
||||||
|
|
||||||
|
Please use the master branch, as it has the most changes.
|
||||||
|
|
||||||
|
Updating the source code is done with this command: `git pull --recurse-submodules`
|
||||||
|
|
||||||
|
## Instances
|
||||||
|
|
||||||
|
* **[openvk.su](https://openvk.su/)**
|
||||||
|
* [social.fetbuk.ru](http://social.fetbuk.ru/)
|
||||||
|
|
||||||
|
## 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. this 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, web-server, Composer, Node.js, Yarn and [Chandler](https://github.com/openvk/chandler)
|
||||||
|
* PHP 8 has **not** yet been tested, so you should not expect it to work.
|
||||||
|
2. Install [commitcaptcha](https://github.com/openvk/commitcaptcha) and OpenVK as Chandler extensions like this:
|
||||||
|
```
|
||||||
|
git clone --recursive 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. 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/
|
||||||
|
```
|
||||||
|
4. Import `install/init-static-db.sql` to **same database** you installed Chandler to
|
||||||
|
5. Import `install/init-event-db.sql` to **separate database**
|
||||||
|
6. Copy `openvk-example.yml` to `openvk.yml` and change options
|
||||||
|
7. Run `composer install` in OpenVK directory
|
||||||
|
8. Move to `Web/static/js` and execute `yarn install`
|
||||||
|
9. Set `openvk` as your root app in `chandler.yml`
|
||||||
|
|
||||||
|
**Note**: If OVK submodules were not downloaded beforehand (i.e. `--recursive` was not used during cloning), this command *must be* executed in the `openvk` folder: `git submodule update --init`
|
||||||
|
|
||||||
|
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 before using the built-in account.
|
||||||
|
|
||||||
|
Full example installation instruction for CentOS 8 is also available [here](docs/centos8_install.md).
|
||||||
|
|
||||||
|
### If my website uses OpenVK, should I publish it's sources?
|
||||||
|
|
||||||
|
You are encouraged to do so. We don't enforce this though. You can keep your sources to yourself (unless you distribute your OpenVK distro to other people).
|
||||||
|
You also not required to publish source texts of your themepacks and plugins.
|
||||||
|
|
||||||
|
## Where can I get assistance?
|
||||||
|
|
||||||
|
You may reach out to us via:
|
||||||
|
* [Bug-tracker](https://github.com/openvk/openvk/projects/1)
|
||||||
|
* [Ticketing system](https://openvk.su/support?act=new)
|
||||||
|
* Telegram chat: Go to [our channel](https://t.me/openvkch) and open discussion in our channel menu.
|
||||||
|
* [Reddit](https://www.reddit.com/r/openvk/)
|
||||||
|
* [Discussions](https://github.com/openvk/openvk/discussions)
|
||||||
|
|
||||||
|
**Attention**: bug tracker and telegram 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**
|
||||||
|
|
||||||
|
<a href="https://codeberg.org/OpenVK/openvk">
|
||||||
|
<img alt="Get it on Codeberg" src="https://codeberg.org/Codeberg/GetItOnCodeberg/media/branch/main/get-it-on-blue-on-white.png" height="60">
|
||||||
|
</a>
|
||||||
|
|
@ -1,72 +0,0 @@
|
||||||
h1. <img align="right" src="https://github.com/openvk/openvk/raw/master/Web/static/img/logo_shadow.png" alt="openvk" title="openvk" width="15%">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 even know whether it even works. However, this version is maintained and we will be happy to accept your bugreports "in our bug-tracker":https://github.com/openvk/openvk/projects/1. You should also be able to submit them using "ticketing system":https://openvk.su/support?act=new (you will need an OVK account for this).
|
|
||||||
|
|
||||||
h2. When's the release?
|
|
||||||
|
|
||||||
Please use the master branch, as it has the most changes.
|
|
||||||
|
|
||||||
Updating the source code is done with this command: @git pull --recurse-submodules@
|
|
||||||
|
|
||||||
h2. Instances
|
|
||||||
|
|
||||||
* *"openvk.su":https://openvk.su/*
|
|
||||||
* "social.fetbuk.ru":http://social.fetbuk.ru/
|
|
||||||
|
|
||||||
h2. 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. this extensions are available on most of ISPManager hostings).
|
|
||||||
Simply put, we would recommend you to use latest CentOS (running on your own VDS/Dedicated) with latest PHP from EPEL. We used to have this configuration on our "main instance":https://openvk.su/ and thus will be able to provide quicker support for OVK running in this environment.
|
|
||||||
If you want, you can add your instance to the list above so that people can register there.
|
|
||||||
|
|
||||||
h3. Installation procedure
|
|
||||||
|
|
||||||
"samukhin":https://github.com/samukhin is working on a Docker container that contains a microblog version of OpenVK, see "#76":https://github.com/openvk/openvk/pull/76 for details. (Experimental)
|
|
||||||
|
|
||||||
# Install PHP 7, web-server, Composer, Node.js, Yarn and "Chandler":https://github.com/openvk/chandler
|
|
||||||
PHP 8 has *not* yet been tested, so you should not expect it to work.
|
|
||||||
# Install "commitcaptcha":https://github.com/openvk/commitcaptcha and OpenVK as Chandler extensions like this:
|
|
||||||
@git clone --recursive 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 *same database* you installed Chandler to
|
|
||||||
# Import @install/init-event-db.sql@ to *separate database*
|
|
||||||
# Copy @openvk-example.yml@ to @openvk.yml@ and change options
|
|
||||||
# Run @composer install@ in OpenVK directory
|
|
||||||
# Move to @Web/static/js@ and execute @yarn install@
|
|
||||||
# Set @openvk@ as your root app in @chandler.yml@
|
|
||||||
|
|
||||||
*Note*: If OVK submodules were not downloaded beforehand (i.e. @--recursive@ was not used during cloning), this command *must be* executed in the @openvk@ folder: @git submodule update --init@
|
|
||||||
|
|
||||||
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 before using the built-in account.
|
|
||||||
|
|
||||||
h3. If my website uses OpenVK, should I publish it's sources?
|
|
||||||
|
|
||||||
You are encouraged to do so. We don't enforce this though. You can keep your sources to yourself (unless you distribute your OpenVK distro to other people).
|
|
||||||
You also not required to publish source texts of your themepacks and plugins.
|
|
||||||
|
|
||||||
h2. Where can I get assistance?
|
|
||||||
|
|
||||||
You may reach out to us via:
|
|
||||||
* "Bug-tracker":https://github.com/openvk/openvk/projects/1
|
|
||||||
* "Ticketing system":https://openvk.su/support?act=new
|
|
||||||
* Telegram chat: Go to "our channel":https://t.me/openvkch and open discussion in our channel menu.
|
|
||||||
* "Reddit":https://www.reddit.com/r/openvk/
|
|
||||||
* "Discussions":https://github.com/openvk/openvk/discussions
|
|
||||||
|
|
||||||
*Attention*: bug tracker and telegram 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*:
|
|
||||||
* *Head of OpenVK Security Commitee*: stingray@jill.pl or "@id155":https://t.me/id155
|
|
||||||
* *Backend developer*: "@saddyteirusu":https://t.me/saddyteirusu
|
|
||||||
|
|
||||||
Codeberg repository clone:
|
|
||||||
<a href="https://codeberg.org/OpenVK/openvk">
|
|
||||||
<img alt="Get it on Codeberg" src="https://codeberg.org/Codeberg/GetItOnCodeberg/media/branch/main/get-it-on-blue-on-white.png" height="60">
|
|
||||||
</a>
|
|
||||||
Loading…
Reference in a new issue