Skip to content

Improved documentation: installing-devshop.md #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improved documentation: installing-devshop.md #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions install-and-upgrade/installing-devshop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# Installing DevShop

There are a number of ways to get DevShop up and running: 1. **Install Script**: [https://github.com/opendevshop/devshop/blob/1.x/install.sh](https://github.com/opendevshop/devshop/blob/1.x/install.sh) Use the standalone install script to fully bootstrap a new Ubuntu or CentOS7 server. Instructions are below. Find the latest release on the [Releases page on the GitHub Repo](http://github.com/opendevshop/devshop/releases). 2. **Docker**: See [hub.docker.com/r/devshop/devmaster/](https://hub.docker.com/r/devshop/devmaster/) for instructions. 3. **Vagrant**: The [core project on GitHub](https://github.com/opendevshop/devshop) contains a Vagrantfile that you may use to launch a working devshop on your local computer. 4. **Ansible**: We have an Ansible role publicly available at [galaxy.ansible.com/opendevshop/devmaster](https://galaxy.ansible.com/opendevshop/devmaster/). The Vagrantfile and standalone install script both use Ansible roles to configure the servers.
There are 4 ways to get DevShop up and running:
1. **Install Script**: [https://github.com/opendevshop/devshop/blob/1.x/install.sh](https://github.com/opendevshop/devshop/blob/1.x/install.sh) Use the standalone install script to fully bootstrap a new Ubuntu or CentOS7 server. The instructions are below. Find the latest release on the [Releases page on the GitHub Repo](http://github.com/opendevshop/devshop/releases).
2. **Docker**: See [hub.docker.com/r/devshop/devmaster/](https://hub.docker.com/r/devshop/devmaster/) for instructions.
3. **Vagrant**: The [core project on GitHub](https://github.com/opendevshop/devshop) contains a Vagrantfile that you may use to launch a working DevShop on your local computer.
4. **Ansible**: We have an Ansible role publicly available at [galaxy.ansible.com/opendevshop/devmaster](https://galaxy.ansible.com/opendevshop/devmaster/). The Vagrantfile and standalone install script both use Ansible roles to configure the servers.

## Standalone Install Script

DevShop can be installed with a standalone [install.sh bash](https://github.com/opendevshop/devshop/blob/1.x/install.sh) script, which kicks off an ansible playbook.
DevShop can be installed with a standalone [install.sh bash](https://github.com/opendevshop/devshop/blob/1.x/install.sh) script, which kicks off an Ansible playbook.

We test this script continuously on Ubuntu and CentOS 7. See [https://travis-ci.org/opendevshop/devshop](https://travis-ci.org/opendevshop/devshop) for the test results.

**NOTES:**

* Do not try to install devshop on a server that is already in use. If you do you will likely have to take manual steps to get it fully functional. It's just easier to start with a fresh server.
* If installing ubuntu manually, do _not_ choose "LAMP Server" or any other type. The install script & ansible role will install all necessary packages.
* Do not try to install DevShop on a server that is already in use. If you do you will likely have to take manual steps to get it fully functional. It's just easier to start with a fresh server.
* If installing ubuntu manually, do _not_ choose "LAMP Server" or any other type. The install script & Ansible role will install all necessary packages.
* **Always** run the install.sh script as _root_. Using `sudo bash install.sh` may not work, as it uses /root/.my.cnf to track database permissions.

[1.x](https://github.com/opendevshop/devshop) is now the current stable branch. `0.x` branch is now deprecated! Drupal 6 is End of Life.
Expand All @@ -29,7 +33,7 @@ _Please,_ check the releases page before installing for the first time to be sur
* Rackspace and DigitalOcean use the name of the server to automatically set the hostname.
* DNS Setup:
* Add a DNS record that points your domain name \(devshop.mydomain.com\) to your server's IP address.
* Add a second DNS record that points a wildcard subdomain of your domain \(\*.devshop.thinkdrop.net\) to your server's IP address. This allows you to setup new sites without having to mess with DNS every time.
* Add a second DNS record that points a wildcard subdomain of your domain \(\*.devshop.thinkdrop.net\) to your server's IP address. This allows you to set up new sites without having to mess with DNS every time.
* Example DNS Records:

```text
Expand Down Expand Up @@ -71,7 +75,7 @@ _Please,_ check the releases page before installing for the first time to be sur

* If you wish to set the Aegir user's UID to something other than 12345, you can use the `--aegir_user_uid` option. This might be useful if you are setting up Docker containers to mounting NFS.

Once you have devshop installed, switch to the Aegir user to access all of the files for all of your sites, include the devmaster front-end.
Once you have DevShop installed, switch to the Aegir user to access all of the files for all of your sites, include the devmaster front-end.

The most important commands to remember are `devshop status` and `devshop login`

Expand All @@ -89,7 +93,7 @@ We strive to make the source code as readable as possible, so please feel free t

In summary, the script does the following:

1. Installs git and Ansible.
1. Installs Git and Ansible.
2. Generates a secure MySQL password and saves it to the /root/.my.cnf.
3. Clones [http://github.com/opendevshop/devshop.git](http://github.com/opendevshop/devshop.git) to /usr/share/devshop and checks out the chosen version. These files include the Ansible playbooks and variables files.
4. Runs the Ansible playbooks listed in [playbook.yml](https://github.com/opendevshop/devshop/blob/1.x/playbook.yml):
Expand Down