Browse Source

Added readme and license.

Ian Adam Naval 5 years ago
parent
commit
413e655f7a
2 changed files with 52 additions and 0 deletions
  1. 20
    0
      LICENSE
  2. 32
    0
      README.md

+ 20
- 0
LICENSE View File

@@ -0,0 +1,20 @@
1
+The MIT License (MIT)
2
+
3
+Copyright (c) 2014 Ian Adam Naval
4
+
5
+Permission is hereby granted, free of charge, to any person obtaining a copy of
6
+this software and associated documentation files (the "Software"), to deal in
7
+the Software without restriction, including without limitation the rights to
8
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9
+the Software, and to permit persons to whom the Software is furnished to do so,
10
+subject to the following conditions:
11
+
12
+The above copyright notice and this permission notice shall be included in all
13
+copies or substantial portions of the Software.
14
+
15
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 32
- 0
README.md View File

@@ -0,0 +1,32 @@
1
+ianonavy
2
+========
3
+
4
+Source code for my personal website.
5
+
6
+Requirements
7
+------------
8
+
9
+* python 2.6+
10
+* pip
11
+* virtualenv
12
+* nginx
13
+* supervisord
14
+
15
+Installing
16
+----------
17
+
18
+Exact commands vary with OS.
19
+
20
+1. Clone git repository. 
21
+2. Create a virtual environment in the same directory, and source the `activate` script. 
22
+3. Navigate into the directory and install the required Python packages with `pip install -r requirements.txt`.
23
+4. Symlink or copy the file `conf/nginx.conf` into the nginx configuration directory (e.g. `/etc/nginx/conf.d/ianonavy.conf` for CentOS).
24
+5. Symlink or copy the file `conf/supervisord.conf` into the supervisord configuration directory.
25
+6. Reload the config files of both nginx and supervisord, and ensure that both daemons are running.
26
+
27
+Note that you probably need to edit the config files to point to the directory in which you cloned this repo as well as the `server_name` for nginx.
28
+
29
+Updating
30
+--------
31
+
32
+To update, just run `git pull` in the repository. For the Web service, you may need to instruct supervisord to restart the daemons.

Loading…
Cancel
Save