Skip to content

Commit

Permalink
Cleaned up Ansible Documentation for v0.7.4
Browse files Browse the repository at this point in the history
  • Loading branch information
yantisj committed Jul 7, 2016
1 parent 768d734 commit d2f7cdf
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 15 deletions.
14 changes: 10 additions & 4 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
## Install Notes

Netgrph was built on Ubuntu 14.04 LTS but should be portable to any other Python
3.4+ system. I have done limited testing at this point on other systems (MacOS),
so I highly recommend this OS right now. In the near future, I plan to ship a
set of ansible scripts for easy install, but at first this is what I have.
3.4+ system. I have done testing on Ubuntu 16.04 and MacOS, and I highly
recommend Ubuntu trusty or xenial for support purposes. I provide ansible
scripts for an easy install on a base Ubuntu system, and will be creating a
Docker file before long.

### Test Install Instructions
### Ansible Install
- See the README.md in docs/playbooks/
- Install ansible on your machine, and point the playbook towards localhost as
documented, or a remote host if you are familiar with Ansible.

### Manual Install Instructions

- For testing, you can install everything but the database under your user on any system
- If you do not have root access to your system, use virtualenv to satisfy the pip requirements
Expand Down
2 changes: 1 addition & 1 deletion docs/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.7.3
v0.7.4
39 changes: 29 additions & 10 deletions docs/playbooks/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,44 @@
## Ansible NetGrph Playbooks

These playbooks will install Ansible on Ubuntu 14.04 or 16.04 for
you. It will not set your database password or configure your
netgrph.ini file for now, so you need to do that manually. Once the
scripts run, browse to http://machine:7474 and setup your
password. Set that same password in /home/netgrph/docs/netgrph.ini,
and run the /home/netgrph/test/first_import.sh.

### Running Ansible via localhost
These playbooks will install NetGrph via Ansible on Ubuntu 14.04 or 16.04 for
you. It will not set your database password or configure your netgrph.ini file
for now, so you need to do that manually. Once the scripts run, browse to
http://machine:7474 and setup your password. Set that same password in
/home/netgrph/docs/netgrph.ini, and run the /home/netgrph/test/first_import.sh.

#### Setting up Ansible to run via localhost

```
sudo su -
apt-get install ansible
echo [netgrph] >> /etc/ansible/hosts
echo '[netgrph]' >> /etc/ansible/hosts
echo localhost ansible_connection=local >> /etc/ansible/hosts
exit
```

#### Run ansible on localhost
#### Run playbooks against localhost (installs under netgrph user)

```
git clone https://github.com/yantisj/netgrph.git /tmp/netgrph/
cd /tmp/netgrph/docs/playbooks/
ansible-playbook netgrph.yml --ask-sudo-pass
```

#### Test the install

```
sudo su - netgrph
cd netgrph
```

##### Use an insecure DB password for testing (not recommended)
```
./test/set_neo4j_password.sh
```

##### Test a database import
```
./test/first_import.sh
```

- See the INSTALL.md file for test queries and production install information

0 comments on commit d2f7cdf

Please sign in to comment.