Merge pull request 'add info about language plugin in readme' (#53) from meazdev into master

Update of the README file (added infor + Arch commands + MD style)
This commit is contained in:
Fede.- 2020-12-04 14:18:59 +00:00
commit 8a0f6b11b7
1 changed files with 165 additions and 100 deletions

View File

@ -1,71 +1,129 @@
# This Vagrant setup is still Work in Progress, though it can be used as is. #### This Vagrant setup is still a "Work in Progress", though it can be used as is.
# Disroot Howto Development Environment using Vagrant # Disroot Howto Development Environment using Vagrant
## requirements ## Requirements
1. vagrant 2.2.6 * **Vagrant 2.2.6**
for install on Debian run commands:
Commands for Vagrant installation
**On Debian based operating systems**
``` ```
wget https://releases.hashicorp.com/vagrant/2.2.6/vagrant_2.2.6_x86_64.deb wget https://releases.hashicorp.com/vagrant/2.2.6/vagrant_2.2.6_x86_64.deb
``` ```
``` ```
sudo dpkg -i vagrant_2.2.6_x86_64.deb sudo dpkg -i vagrant_2.2.6_x86_64.deb
``` ```
``` ```
sudo apt install -f sudo apt install -f
``` ```
2. virtuabox **On Arch based operating systems**
for install on Debian Jessie run command:
```
sudo pacman -S vagrant
```
* **VirtuaBox**
Commands for VirtuaBox installation
**On Debian Jessie**
``` ```
sudo apt install virtualbox-6.0 sudo apt install virtualbox-6.0
``` ```
for install on Debian Buster run command: **On Debian Buster**
``` ```
sudo echo 'deb http://download.virtualbox.org/virtualbox/debian buster contrib' > /etc/apt/sources.list.d/virtualbox.list sudo echo 'deb http://download.virtualbox.org/virtualbox/debian buster contrib' > /etc/apt/sources.list.d/virtualbox.list
``` ```
``` ```
wget -q https://www.virtualbox.org/download/oracle_vbox_2016.asc -O- | sudo apt-key add - wget -q https://www.virtualbox.org/download/oracle_vbox_2016.asc -O- | sudo apt-key add -
wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | sudo apt-key add - wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | sudo apt-key add -
``` ```
``` ```
sudo apt-get update ; sudo apt-get install virtualbox-6.0 sudo apt-get update ; sudo apt-get install virtualbox-6.0
``` ```
3. vagrant plugins vagrant-vbguest: **On Arch based operating systems**
for install on Debian run commands:
```
sudo pacman -S virtualbox
```
* **Vagrant plugins vagrant-vbguest**
Commands for Vagrant plugins installation
``` ```
vagrant plugin install vagrant-vbguest vagrant plugin install vagrant-vbguest
``` ```
4. git * **Git**
Commands for git installation
**On Debian based operating systems**
``` ```
sudo apt install git sudo apt install git
``` ```
## Installation **On Arch based operating systems**
1. Create a Disroot folder, in which you'll clone the repository:
``` ```
mkdir ~/Disroot sudo pacman -S git
``` ```
2. Clone howto repo to Disroot folder
## Installing the Vagrant virtual machine
1. Create the Disroot folder in which the repositories will be cloned, and enter it
``` ```
git clone https://git.fosscommunity.in/disroot/howto.git ~/howto mkdir ~/Disroot ; cd ~/Disroot
``` ```
3. Add the local domain name for the hub to your host machine's `/etc/hosts` file.
2. Clone the Howto repository inside the Disroot folder
```
git clone https://git.disroot.org/Disroot/Howto.git
```
3. Clone the grav-plugin-language-selector repository inside this same Disroot folder
```
git clone https://git.disroot.org/Disroot/grav-plugin-language-selector.git
```
4. Add the local domain name for the hub to your host machine's `/etc/hosts` file.
``` ```
echo "192.168.33.11 howto.disroot.lan" >> /etc/hosts echo "192.168.33.11 howto.disroot.lan" >> /etc/hosts
``` ```
4. Launch Vagrant to build the virtual machine (VM). This will take several minutes.
5. Go to the Vagrant folder inside the cloned repository...
``` ```
cd ~/Disroot/howto/vagrant cd ~/Disroot/howto/vagrant
```
... and launch Vagrant to build the virtual machine (VM). This will take several minutes.
```
vagrant up howto_disroot_lan vagrant up howto_disroot_lan
``` ```
Congratulations, you should now have a fully functioning apache+GRAV server running locally in a Virtualbox-hosted VM managed by Vagrant. Next time you want to run vagrant simply run command **Congratulations!** You should now have a fully functioning Nginx + GRAV server running locally in a VirtualBox-hosted VM managed by Vagrant.
Next time you want to run Vagrant simply use the commands
``` ```
cd ~/Disroot/howto/vagrant cd ~/Disroot/howto/vagrant
vagrant up howto_disroot_lan vagrant up howto_disroot_lan
@ -74,19 +132,24 @@ Congratulations, you should now have a fully functioning apache+GRAV server runn
### Enable SSH access ### Enable SSH access
To make your development workflow more efficient, you may wish to use an SSH connection to rapidly synchronize the files you are developing in your local (host machine) development environment. To make your development workflow more efficient, you may wish to use an SSH connection to quickly synchronize the files you are developing in your local (host machine) development environment.
1. On your host machine, copy your public key. 1. On your host machine, copy your public key.
``` ```
user@host:~$ cat ~/.ssh/id_rsa.public user@host:~$ cat ~/.ssh/id_rsa.public
ssh-rsa eLX1UQbJHUCHf2V3K7YlMP0YmIT+50rlEsWre1eobApKb0Ac/WbvssX/Gh/ user@host ssh-rsa eLX1UQbJHUCHf2V3K7YlMP0YmIT+50rlEsWre1eobApKb0Ac/WbvssX/Gh/ user@host
``` ```
2. Use `vagrant ssh howto_disroot_lan` to log in to the virtual machine. 2. Use `vagrant ssh howto_disroot_lan` to log in to the virtual machine.
``` ```
user@host:~$ cd ~/Disroot/howto/vagrant user@host:~$ cd ~/Disroot/howto/vagrant
user@host:hubzilla-vagrant$ vagrant ssh howto_disroot_lan user@host:hubzilla-vagrant$ vagrant ssh howto_disroot_lan
``` ```
3. Switch to root and add your host user public key. 3. Switch to root and add your host user public key.
``` ```
vagrant@stretch:~$ sudo -i vagrant@stretch:~$ sudo -i
root@jessie:~# ssh-keygen root@jessie:~# ssh-keygen
@ -113,7 +176,9 @@ To make your development workflow more efficient, you may wish to use an SSH con
+-----------------+ +-----------------+
root@stretch:~# echo "ssh-rsa eLX1UQbJHUCHf2V3K7YlMP0YmIT+50rlEsWre1eobApKb0Ac/WbvssX/Gh/ user@host" >> ~/.ssh/authorized_keys root@stretch:~# echo "ssh-rsa eLX1UQbJHUCHf2V3K7YlMP0YmIT+50rlEsWre1eobApKb0Ac/WbvssX/Gh/ user@host" >> ~/.ssh/authorized_keys
``` ```
4. From your host machine, you may now SSH into the virtual machine using 4. From your host machine, you may now SSH into the virtual machine using
``` ```
ssh root@howto.disroot.lan ssh root@howto.disroot.lan
``` ```