Browse Source

Updated README.md

Óscar García Amor 4 years ago
parent
commit
8920fa9a0e
2 changed files with 29 additions and 1 deletions
  1. 28 0
      README.md
  2. 1 1
      sysdweb/templates/views/index.tpl

+ 28 - 0
README.md

@@ -1,2 +1,30 @@
 # sysdweb
 Control systemd services through Web or REST API
+
+## Installation
+
+```sh
+git clone https://github.com/ogarcia/sysdweb.git
+virtualenv3 ./sysdweb-venv
+source ./sysdweb-venv/bin/activate
+cd sysdweb
+python setup.py install
+```
+
+## Run
+
+First take a look to `sysdweb.conf` file to configure sysdweb. Is self
+explanatory.
+
+Once you have configured sysdweb, simply run.
+
+```
+sysdweb
+```
+
+By default sysdweb listen in 10080 port to all hosts, you can change listen
+port and address with `-p` and `-l`.
+
+```sh
+sysdweb -p 9080 -l 127.0.0.1
+```

+ 1 - 1
sysdweb/templates/views/index.tpl

@@ -5,7 +5,7 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
-    <title>{{hostname or 'sysdweb'}} mini control</title>
+    <title>{{hostname or 'sysdweb'}} · sysdweb</title>
 
     <!-- Bootstrap -->
     <link href="css/bootstrap.min.css" rel="stylesheet">