Django-based framework for building web hosting control panels

Go to file

Marc Aymerich 1bb37b1175 Commented django_mailer app		2015-05-01 18:18:13 +00:00
docs	Random fixes	2015-04-20 14:23:10 +00:00
orchestra	Commented django_mailer app	2015-05-01 18:18:13 +00:00
scripts	Added ID to serializers	2015-04-30 09:51:55 +00:00
.gitignore	Modified gitignore	2015-05-01 18:23:43 +02:00
INSTALL.md	Fixes on orchestra deployment	2015-04-29 21:35:56 +00:00
LICENSE	Changed license	2014-11-13 17:47:45 +00:00
MANIFEST.in	Initial commit	2014-05-08 16:59:35 +00:00
README.md	Update README.md	2015-05-01 20:15:35 +02:00
ROADMAP.md	Added orchestrate management command	2015-04-01 15:49:21 +00:00
TODO.md	Added create initial superuser prompt on accounts post migrate	2015-05-01 18:05:34 +00:00
requirements.txt	Added requirements.txt, fixed import cracklib on some systems	2015-05-01 18:11:19 +02:00
setup.py	More fixes for python 3 compat	2015-04-03 10:14:45 +00:00

README.md

This project is in early development stage

Django Orchestra

Orchestra is a Django-based framework for building web hosting control panels.

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.

Overview

Django-orchestra is mostly a bunch of plugable applications providing common functionalities, like service management, resource monitoring or billing.

The admin interface relies on Django Admin, but enhaced with Django Admin Tools and Django Fluent Dashboard. Django REST Framework is used for the REST API, with it you can build your client-side custom user interface.

Every app is reusable, this means that you can add any Orchestra application into your Django project INSTALLED_APPS strigh away. However, Orchestra also provides glue, tools and patterns that you may find very convinient to use. Checkout the documentation if you want to know more.

Fast Deployment Setup

To only run the Python interface follow these steps:

python3 -menv env-django-orchestra
source env-django-orchestra/bin/activate
echo $HOME/django-orchestra/ | sudo tee env-django-orchestra/lib/python3*/site-packages/orchestra.pth
pip3 install -r $HOME/django-orchestra/requirements.txt
django-admin.py startproject panel --template="$HOME/django-orchestra/orchestra/conf/project_template"
python3 panel/manage.py migrate accounts
python3 panel/manage.py migrate
python3 panel/manage.py runserver

None of the services will work but you can see the web interface on http://localhost:8000/admin

Development and Testing Setup

If you are planing to do some development or perhaps just checking out this project, you may want to consider doing it under the following setup

Create a basic LXC container, start it and get inside.

wget -O /tmp/create.sh \
  https://raw.github.com/glic3rinu/django-orchestra/master/scripts/container/create.sh
sudo bash /tmp/create.sh
sudo lxc-start -n orchestra
# root/root

Deploy Django-orchestra development environment inside the container

# Make sure your container is connected to the Internet
# Probably you will have to configure the NAT first:
#   sudo iptables -t nat -A POSTROUTING -s `container_ip` -j MASQUERADE
wget -O /tmp/deploy.sh \
  https://raw.github.com/glic3rinu/django-orchestra/master/scripts/container/deploy.sh
cd /tmp/ # Moving away from /root before running deploy.sh
bash /tmp/deploy.sh

Django-orchestra source code should be now under ~orchestra/django-orchestra and an Orchestra instance called panel under ~orchestra/panel

Nginx should be serving on port 80, but Django's development server can be used as well:
```
su - orchestra
cd panel
python manage.py runserver 0.0.0.0:8888
```
A convenient practice can be mounting ~orchestra on your host machine so you can code with your favourite IDE, sshfs can be used for that
```
# On your host
mkdir ~<user>/orchestra
sshfs orchestra@<container-ip>: ~<user>/orchestra
```

To upgrade to current master just re-run the deploy script

sudo ~orchestra/django-orchestra/scripts/container/deploy.sh

License

Django-orchestra is licensed under The BSD License (3 Clause, also known as the new BSD license). The license is an OSI approved Open Source license and is GPL-compatible(1).

The license text can also be found here: http://www.opensource.org/licenses/BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Marc Aymerich, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Ask Solem OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.