diff options
| author | Filipp Lepalaan <filipp@mac.com> | 2015-09-13 22:47:49 +0300 |
|---|---|---|
| committer | Filipp Lepalaan <filipp@mac.com> | 2015-09-13 22:47:49 +0300 |
| commit | 2a12da74f883b30532c886b4136adff1a4df256c (patch) | |
| tree | baba592fe139ce0c7d112f72cbc6b6e9300e1e24 /README.md | |
| parent | 5ae2336abc50f6874e5c0df785d3dbe5016d459d (diff) | |
| download | Servo-2a12da74f883b30532c886b4136adff1a4df256c.tar.gz Servo-2a12da74f883b30532c886b4136adff1a4df256c.tar.bz2 Servo-2a12da74f883b30532c886b4136adff1a4df256c.zip | |
Updated readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 42 |
1 files changed, 39 insertions, 3 deletions
@@ -1,7 +1,19 @@ Introduction ============ + Servo is a service management system for Authorised Apple Service Providers. +System Requirements +=================== + +The application is written in Python on top of the Django web framework and depends on the latest stable versions of the following components for operation: + +- PostgreSQL +- Memcache +- RabbitMQ +- uwsgi +- Python 2.7 + Installation ============ @@ -10,6 +22,16 @@ Install PostgreSQL, nginx, memcached, rabbitMQ. Then install the necessary Pytho $ pip install -U -r requirements.pip +Then clone the code: + + $ git clone https://github.com/fpsw/Servo.git my_servo_folder + $ cd my_servo_folder + $ pip install -U -r requirements.pip + + +Configuration +============= + Edit local_settings.py (these are settings specific to your installation): import logging @@ -45,7 +67,7 @@ Edit local_settings.py (these are settings specific to your installation): INSTALL_LOCALE = 'sv_SE.UTF-8' # Default setting for locale INSTALL_LANGUAGE = 'se' # Default setting for language - SERVO_URL = 'http://123.123.123.123' # External IP for SMS delivery reports + SERVO_URL = 'http://123.123.123.123' # External IP for SMS delivery reports (if your SMS provider supports them) ENABLE_RULES = True # Whether or not you want to run rules @@ -53,10 +75,24 @@ Edit local_settings.py (these are settings specific to your installation): For testing, you can run Servo without any extra setup: - cd my_servo_folder - python ./manage.py runserver + $ cd my_servo_folder + $ python ./manage.py runserver + +Then fire up your browser and got to http://localhost:8080/ + + +Updating +======== + +First, back up your database, then: + + $ git pull origin master + $ ./manage.py migrate --no-initial-data + +After which you should restart your Servo instance. Documentation ============= + End-user documentation for the system is available [here](https://docs.servoapp.com). |