Commit d5b285d1 authored by Joachim Mathes's avatar Joachim Mathes

TASK: Update documentation

parent 84560159
......@@ -20,8 +20,8 @@ The box as a breakable toy
![juggling schorsch][juggling_schorsch]
As a general concept consider the box as a breakable toy. Feel free do destroy the box at any time, but keep in mind
that anything _inside_ the box will be lost.
As a general concept consider the box as a breakable toy. Feel free do destroy the box at any time with `vagrant destroy`,
but keep in mind that anything _inside_ the box will be lost.
Questions
---------
......
Deployment
==========
As a proof of concept deployment to `vpro0100.proserver.punkt.de` is possible from within
the box. It is recommended to set up a centralized deployment concept with your favorite
CI infrastructure, e.g. [Jenkins](https://jenkins.io/), [gitlab](https://gitlab.com), etc.
For deployment you need to have access to `vpro0100.proserver.punkt.de` as user `proserver`.
Thus, your public key has to be provided. Please inform one of the already registered users
or ask [technik@punkt.de](mailto:technik@punkt.de) if you need access.
Login as user `proserver` to allow agent forwarding. Login as user `vagrant` and sudo to `proserver` won't work!
Run `vagrant ssh-config` to find the private key path of user `vagrant`. The result will look somehow like this:
Run
```
vagrant ssh-config | grep IdentityFile | awk '{print $2}'
```
to find the private key path of user `vagrant`.
Then run
```
ssh -A -i /Users/<USER>/.vagrant.d/insecure_private_key proserver@172.17.28.100
```
and go to
```
cd /var/www/t3o
```
Finally it's surf, which will deploy the application to `vpro0100.proserver.punkt.de`:
```
php surf.phar deploy production
```
If `vagrant ssh-config | grep IdentityFile | awk '{print $2}'` does not work, try
```
vagrant ssh-config
```
The result will look somehow like this:
```
/Users/<USER>/projects/typo3.org > vagrant ssh-config
......@@ -24,21 +51,4 @@ LogLevel FATAL
ForwardAgent yes
```
Line `IdentityFile` is what you need. A more sophisticated way to get the path would be:
```
vagrant ssh-config | grep IdentityFile | awk '{print $2}'
```
Then run
```
ssh -A -i /Users/<USER>/.vagrant.d/insecure_private_key proserver@172.17.28.100
```
and go to
```
cd /var/www/t3o
```
Finally it's surf, which will deploy the application to `vpro0100.proserver.punkt.de`:
```
php surf.phar deploy production
```
The path in the line starting with `IdentityFile` is what you need.
......@@ -3,12 +3,21 @@ Installation
![throwing schorsch][throwing_schorsch]
Go to your project directory and run `fab initialize_proserver_box`. It
Go to your project directory and run `vagrant up`. It
1. downloads a generic proServer vagrant box from punkt.de and boots it.
2. puts the public key of box user `vagrant` to box user `proserver`.
3. injects the project from your host's workspace into the box.
4. runs composer to initialize the project.
2. clones project [typo3.org](https://gitlab.pluspunkthosting.de/T3O/typo3.org.git) into the box
Enter the box and initialize the project:
```
vagrant ssh
cd /var/www/t3o
./t3o init
```
The shell script
1. runs composer to initialize the project.
The `composer` run will be interrupted and ask you for `username` and `password` of
your `typo3.org` account to download `t3o/t3olayout`.
```
......@@ -22,8 +31,8 @@ Go to your project directory and run `fab initialize_proserver_box`. It
...
```
Enter valid credentials and the installation will continue.
5. downloads and imports the `t3o` database from `vpro0100.proserver.punkt.de`.
6. restarts `php-fpm`
7. downloads the initialized project from the box to your hosts's workspace.
2. creates MariaDB user and database.
3. downloads and imports the `t3o` database from `vpro0100.proserver.punkt.de`.
4. restarts `php-fpm`
[throwing_schorsch]: throwing_schorsch.png "Throwing Schorsch"
......@@ -3,23 +3,10 @@ Prerequisites
* [VirtualBox](https://www.virtualbox.org)
* [Vagrant](https://www.vagrantup.com)
* [Python 2.7](https://www.python.org)
* [fabric](http://www.fabfile.org)
The box is tested with
* VirtualBox 4.3.40 and 4.3.30
* Vagrant 1.8.5 and 1.6.3
* Python 2.7
* Fabric 1.11.1 with Paramiko 1.16.0
but should work with current versions. Please [let us know](mailto:technik@punkt.de), if any problems occur.
Installation
------------
Use your system specific package management system like `brew` on MacOS or `apt-get` on Linux
to install the respective packages. `fabric` can also be installed via python's `pip`:
```
sudo pip install fabric
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment