From 50ff252be72201ac5ce63e8bcfffaf38c2c9067c Mon Sep 17 00:00:00 2001 From: Marc Aymerich Date: Wed, 17 Feb 2016 09:22:43 +0000 Subject: [PATCH] Updated README --- README.md | 20 +++++++++++--------- orchestra/contrib/webapps/types/misc.py | 7 ++++--- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2b81d4e1..29201309 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Motivation ---------- There are a lot of widely used open source hosting control panels, however, none of them seems apropiate when you already have an existing service infrastructure or simply you want your services to run on a particular architecture. -The goal of this project is to provide the tools for easily build a fully featured control panel that is not tied to any particular service architecture. Orchestra +The goal of this project is to provide the tools for easily build a fully featured control panel that is not tied to any particular service architecture. Overview -------- @@ -32,7 +32,10 @@ Overview Fast Deployment Setup --------------------- -This deployment is **not suitable for production** but more than enough for checking out this project. + +This deployment is **not suitable for production** but more than enough for checking out this project. Checkout the steps for other deployments: +* [development](INSTALLDEV.md) +* [production](INSTALL.md) ```bash # Create and activate a Python virtualenv @@ -52,9 +55,8 @@ python3 panel/manage.py migrate python3 panel/manage.py runserver ``` -Now you can see the web interface on http://localhost:8000/admin/ +Now you can see the web interface on `http://localhost:8000/admin/` -Checkout the steps for other deployments: [development](INSTALLDEV.md), [production](INSTALL.md) Quick Start @@ -70,14 +72,14 @@ Quick Start ``` Then add the servers using the web interface `/admin/orchestration/servers`, check that the SSH connection is working and Orchestra can report the uptime of the servers. -2. It is recommended to configure one service at a time, staring with domains, databases, webapps, websites, ... - 1. Add the [route](orchestra/contrib/orchestration) via `/admin/orchestration/route/` +2. Configure the services, one at a time, staring with domains, databases, webapps, websites, ... + 1. Add related [routes](orchestra/contrib/orchestration) via `/admin/orchestration/route/` 2. Configure related settings on `/admin/settings/setting/` 3. If required, configure related [resources](orchestra/contrib/resources) like Account disc limit, VPS traffic, etc `/resources/resource/` - 3. Test that everything works as expected by creating and deleting service instances - 4. Do the same for the remaining services, you can disable the services that you don't want by editing `INSTALLED_APPS` setting. + 3. Test creating and deleting service instances works as expected + 4. Do the same for the remaining services. You can disable services that you don't want by editing `INSTALLED_APPS` setting -3. Configure billing by adding [services](orchestra/contrib/services) `/admin/services/service/add/` and [plans](orchestra/contrib/plans) `/admin/plans/plan/`. Once a service is created hit the *Update orders* button to create the orders for the existing service instances. +3. Configure billing by adding [services](orchestra/contrib/services) `/admin/services/service/add/` and [plans](orchestra/contrib/plans) `/admin/plans/plan/`. Once a service is created hit the *Update orders* button to create orders for existing service instances. diff --git a/orchestra/contrib/webapps/types/misc.py b/orchestra/contrib/webapps/types/misc.py index 81224e71..f3837fd6 100644 --- a/orchestra/contrib/webapps/types/misc.py +++ b/orchestra/contrib/webapps/types/misc.py @@ -26,8 +26,9 @@ class WebalizerApp(AppType): name = 'webalizer' verbose_name = "Webalizer" directive = ('static', '%(app_path)s%(site_name)s') - help_text = _("This creates a Webalizer application under " - "~/webapps/<app_name>-<site_name>") + help_text = _( + "This creates a Webalizer application under ~/webapps/<app_name>-<site_name>
" + "Statistics will be collected once this app is mounted into one or more Websites.") icon = 'orchestra/icons/apps/Stats.png' option_groups = () @@ -39,7 +40,7 @@ class WebalizerApp(AppType): class SymbolicLinkForm(PHPAppForm): path = forms.CharField(label=_("Path"), widget=forms.TextInput(attrs={'size':'100'}), - help_text=_("Path for the origin of the symbolic link.")) + help_text=_("Path for the origin of the symbolic link.")) class SymbolicLinkSerializer(PHPAppSerializer):