<commit_before>Shepherd
========

Shepherd is configuration and server management wrapped in an easy to use, straightforward package.

Install
=======

At the moment there are no binaries available. They will be coming shortly.

Configuration Examples
======================

To run these examples save them in a file and run shepherd followed by the name of the file(s) to run. For example if you created a file named web_servers.js you would call:

```
shepherd web_servers.js
```

Install packages on Debian based systems:

```javascript
apt("example-pkg")
// Install multiple packages
apt(["example-pkg", "example-pkg2"])
```

Create 100 directories:

```javascript
for (var i = 0; i<100; i++) {
	directory("test"+i)
}
```

Create a PostgreSQL user and database:

```javascript
user = "example"

pg_user(
	user,													// Use the user variable set above
	"password",										// Set the password (unencrypted)
	{
		username: "postgres",				// default is root
		password: "",								// default is blank
		host: "localhost",					// default is localhost
		port: 5432,									// default is 3306
		ssl: false									// do not use ssl
	}
)

pg_database(
	"example",									// database name
	user,												// database owner
	{
		username: "postgres",
		password: "",
		host: "localhost",
		port: 5432,
		ssl: false
	}
)
```

Create an operating system user:

```javascript
user(
	"user1",
	{
		homeDir: "/home/user1",
		shell: "/bin/bash",
		uid: 500,
		gid: 500<commit_msg>README clean up and added installation section.<commit_after>Shepherd
========

Shepherd is configuration and server management wrapped in an easy to use, straightforward package.

Install
=======

#### RPM based systems
```
# rpm -i http://netserious.com/downloads/shepherd-0.5.0-1.x86_64.rpm
```

#### Debian
```
# wget http://netserious.com/downloads/shepherd_0.5.0_amd64.deb
# dpkg -i shepherd_0.5.0_amd64.deb
```

#### Mac OS X

Download the latest pkg from http://netserious.com/downloads and double click on the installer.


Configuration Examples
======================

To run these examples save them in a file and run shepherd followed by the name of the file(s) to run. For example if you created a file named web_servers.js you would call:

```
shepherd web_servers.js
```

Install packages on Debian based systems:

```javascript
apt("example-pkg")
// Install multiple packages
apt(["example-pkg", "example-pkg2"])
```

Create 100 directories:

```javascript
for (var i = 0; i<100; i++) {
	directory("test"+i)
}
```

Create a PostgreSQL user and database:

```javascript
user = "example"

pg_user(
	user,
	"password",
	{
		username: "postgres",
		password: "",
		host: "localhost",
		port: 5432,
		ssl: false
	}
)

pg_database(
	"example",
	user,
	{
		username: "postgres",
		password: "",
		host: "localhost",
		port: 5432,
		ssl: false
	}
)
```

Create an operating system user:

```javascript
user(
	"user1",
	{
		homeDir: "/home/user1",
		shell: "/bin/bash",
		uid: 500,
		gid: 500
{'fraction_non_alphanumeric': 0.14894330761489433, 'fraction_numerical': 0.023482053002348204, 'mean_word_length': 3.5876923076923077, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3412787', 'n_tokens_mistral': 1138, 'n_tokens_neox': 956, 'n_words': 327}