Skip to content

Commit ee5992f

Browse files
committed
Trying to get readme mark up ready
1 parent 9f01c54 commit ee5992f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README renamed to README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# c4-bootstrap
1+
#c4-bootstrap
22

33
A quick and simple configuration tool to build servers (cloud or real) to a consitant install level, provided by channel4.com
44

5-
## Concept
5+
##Concept
66

77
c4-bootstrap is split into to major scripts and two directory structures.
88

9-
## Requirements
9+
##Requirements
1010

11-
## Commands
11+
##Commands
1212

13-
### bootstrap.sh
13+
###bootstrap.sh
1414
bootstrap.sh allows you to quickly setup your system to specified environment, it will run pre.d and post.d scripts and also copy your directory structure from files to the root of the system. The follow explains how the script works.
1515

16-
#### Environment checks
16+
####Environment checks
1717
On running the bootstrap.sh scrip the system checks for the system distro name and the version. The version number can be tweaked at the top of the file by altering the followinf variable:
1818

1919
supported_dist="Ubuntu"
@@ -23,21 +23,21 @@ To set the script to not copy files to the root directory change the following v
2323

2424
prod=1
2525

26-
#### pre.d scripts
26+
####pre.d scripts
2727
The script will then itterate through scripts/pre.d/XXXX and run each script in order. These are simply bash scripts to perform initial tasks such as install dependancies. An example script is provided. Scripts are run in order so 00-.... will be run before 01-....
2828

29-
#### exploding files
29+
####exploding files
3030
This part of the script takes the contents of files/.... and copies them to / This allows you to include files such as a custom motd or something more useful like a sites-enabled config for nginx or apache. To set the script to not copy files to the root directory change the following value to 0 in this case the files will be copied to /tmp/c4-bootstrap.
3131

3232
prod=0
3333

34-
#### post.d
34+
####post.d
3535
The final part of the script is post.d. This is called in the same way as pre.d and itterates through scripts/post.d/XXXX. In post.d you should run things that can only be done once the software is installed and the files are in place. An example of this would be _*a2ensite mysite.conf*_. Yet again these are bash scripts and will be run in numerical order.
3636

37-
### repack.sh
37+
###repack.sh
3838
whilst repack.sh allows you to commit local system changes back to a git repo in order repeat these changes on other servers.
3939

40-
### Files
40+
###Files
4141

4242
The file structure of the system is kept within files, this should be treated as a mirror of your root / for example files/etc/nginx/nginx.conf after bootstrap.sh is run will map to /etc/nginx/nginx.conf
4343

0 commit comments

Comments
 (0)