Permalink
Browse files

Fixes to the readme

  • Loading branch information...
1 parent db17268 commit eecd9fabfe89078507c24f9a4209f4da56923fcb @kelvl kelvl committed Oct 17, 2012
Showing with 46 additions and 41 deletions.
  1. +46 −41 README.md
View
87 README.md
@@ -15,10 +15,9 @@ For more information, check out our blog post on Shadow.
## Installing
- No escalated privledges needed unless you are using privileged ports.
- This will install the core libraries into your site-packages directory.
+No escalated privledges needed unless you are using privileged ports. This will install the core libraries into your site-packages directory.
- python setup.py install
+ python setup.py install
## Configuring
@@ -28,42 +27,46 @@ debug_shadow.conf.py - for local development and debugging
shadow.conf.py - for running a shadow service
- # Shadow specific configuration
-
- ui = {
- # port and address for the UI
- 'port': 9000,
- 'address': '0.0.0.0',
- }
+```python
- proxy = {
-
- # address and port shadow runs on
- 'address': '0.0.0.0',
- 'port': 8081,
-
- # server running the old versions of the code
- 'old_servers': ['http://localhost:8081/'],
-
- # timeout values to use when making requests to old server
- 'old_servers_timeout': 15.0,
-
- # Additional parameters that we want to add
- # when making requests to the old server.
- # These will overwrite the existing params in the request
-
- 'old_servers_additional_get_params': [],
- 'old_servers_additional_post_params': [],
- 'old_servers_additional_headers': [],
-
- # same parameters can be used for the new server
- 'new_servers': ['http://localhost:8081/'],
- 'new_servers_timeout': 15.0,
+# Shadow specific configuration
+
+ui = {
+ # port and address for the UI
+ 'port': 9000,
+ 'address': '0.0.0.0',
+}
+
+proxy = {
+
+ # address and port shadow runs on
+ 'address': '0.0.0.0',
+ 'port': 8081,
+
+ # server running the old versions of the code
+ 'old_servers': ['http://localhost:8081/'],
+
+ # timeout values to use when making requests to old server
+ 'old_servers_timeout': 15.0,
+
+ # Additional parameters that we want to add
+ # when making requests to the old server.
+ # These will overwrite the existing params in the request
- 'new_servers_additional_get_params': [],
- 'new_servers_additional_post_params': [],
- 'new_servers_additional_headers': [],
- }
+ 'old_servers_additional_get_params': [],
+ 'old_servers_additional_post_params': [],
+ 'old_servers_additional_headers': [],
+
+ # same parameters can be used for the new server
+ 'new_servers': ['http://localhost:8081/'],
+ 'new_servers_timeout': 15.0,
+
+ 'new_servers_additional_get_params': [],
+ 'new_servers_additional_post_params': [],
+ 'new_servers_additional_headers': [],
+}
+
+```
There are also Gingko specific configuration parameters for managing service and daemonization.
@@ -73,18 +76,19 @@ Check out Ginkgo's [docs](http://ginkgo.readthedocs.org/en/latest/index.html) fo
Local development execution can be done with:
- ginkgo debug_shadow.conf.py
+ ginkgo debug_shadow.conf.py
Server execution should be done with:
- ginkgoctl shadow.conf.py start
+ ginkgoctl shadow.conf.py start
+Be default, the UI can be accessed at [http://localhost:9000](http://localhost:9000)
##Testing
- Tests are in the `tests` directory. Run them using nose
+Tests are in the `tests` directory. Run them using nose
- nosetests tests/
+ nosetests tests/
## Based upon
@@ -96,3 +100,4 @@ Server execution should be done with:
* [Socketio](http://socket.io/)
* [AngularJS](http://angularjs.org/)
* [jsdiff](https://github.com/kpdecker/jsdiff)
+

0 comments on commit eecd9fa

Please sign in to comment.