From f7267903a9d458b5c6326bbbdd61a7b693dba1d5 Mon Sep 17 00:00:00 2001 From: Alexander Minkin Date: Sun, 31 Jan 2021 00:57:09 +0300 Subject: [PATCH] Make INSTALL.txt a markdown file and format it --- INSTALL.md | 21 +++++++++++++++++++++ INSTALL.txt | 17 ----------------- 2 files changed, 21 insertions(+), 17 deletions(-) create mode 100644 INSTALL.md delete mode 100644 INSTALL.txt diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 00000000..7f2f51d1 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,21 @@ +# 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). \ No newline at end of file diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 index 22d1e9cb..00000000 --- a/INSTALL.txt +++ /dev/null @@ -1,17 +0,0 @@ -OpenVK Install Instructions ------------ -1) Install Composer, Node.js, Yarn and Chandler (https://github.com/openvk/chandler) -2) Install commitcaptcha (https://github.com/openvk/commitcaptcha) and OpenVK as Chandler extensions and enable them like this: -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.