README

Welcome to ACSPanel - The server administration tool written in Symfony2

This document contains information on how to download, install, and start using ACSPanel.

Features:

Multiserver: ACSPanel can be decentralized, you can have how many servers as you wish for each service. Each server will know what has to do.
Role based user system: ACSPanel has 4 basic roles, superadmin, admin, reseller and final user. Each one with its different available actions based on its permissions and assigned plans.
Plan system: ACSPanel works with custom Plans, you can create your different Plans to manage your resources.
Logged actions: Each change in the database is logged in database. You can know what did anyone and also check the changes and do rollback to the entity (Comming soon...). Thanks to StofDoctrineExtensionsBundle and DoctrineExtensions
Themeable. Thanks to LiipThemeBundle, (GUI Designers needed)
Mobile front-end (Comming soon...):
Wordpress farm: See PanelWordpressBundle
Multilanguage: Each user can select the prefered language. (Translators needed)

How it works:

ACSPanel is just a Front-end for a custom Database with all the information related with your services. All the services ask to the panel database what configuration has to load.

Services supported (At the moment):

DNS: PowerDNS
Web: Apache2, Apache2 webproxy
Database: MySQL
FTP: ProFTPd, PureFTPd

Installing ACSPanel

When it comes to installing the ACSPanel, you have the following options.

Download from GIT repository

To install ACSPanel from git repository, you have to clone the project with the next command and execute the following commands

cd /server_root_directory/

git clone https://github.com/AltCtrlSupr/acspanel.git

Checking your System Configuration

Before starting using ACSPanel you should make sure that your local system is properly configured.

Execute the check.php script from the command line:

php app/check.php

The panel needs the next requeriments To work right:

php5-curl

Permissions

To avoid permissions issues after executing console commands you should do the next

mkdir app/main/cache && mkdir app/main/logs (TODO: check this to be created with the initial files...)
sudo setfacl -R -m u:www-data:rwX -m u:`whoami`:rwX app/main/cache app/main/logs
sudo setfacl -dR -m u:www-data:rwx -m u:`whoami`:rwx app/main/cache app/main/logs

Setting up ACSPanel

Now you set parameters.yml with your database create, you can take parameters.yml.sample as example. (Not necessary when it's installed via deb package).

cp app/main/config/parameters.yml.sample app/main/config/parameters.yml

You should create your own config_dev.yml, as the parameters you can take config_dev.yml.sample as example.

cp app/main/config/config_dev.yml.sample app/main/config/config_dev.yml

To install all the dependencies you have to execute composer.phar command.

php composer.phar install

Then you are ready to create the acspanel basic schema executing the next command:

php app/console doctrine:schema:create

Preparing ACL tables

php app/console init:acl

You can load some basic fixtures doing next, like basic groups and admin to start using the panel:

php app/main/console doctrine:fixtures:load

The basic fixtures, adds the superadmin user to let you start to work with the panel. Its default password is 1234. The acspanel will redirect you to password change screen where you should change the password.

You should install the assets as well:

php app/console assets:install --symlink

Congratulations! You're now ready to use ACSPanel.

Setting up Apache2

<VirtualHost *:80>
    DocumentRoot /home/user/www/acspanel/web
    <Directory /home/user/www/acspanel/web/>
        Options Indexes FollowSymLinks MultiViews
        AllowOverride All
        Order allow,deny
        allow from all
    </Directory>
</VirtualHost>

Ensure you have rewrite mode enabled

Getting started with ACSPanel

Changing the panel view parameters:

edit app/main/config/config.yml // Set variables from twig globals, you can change the default date format, the panel name and breadcumb separation character

Setting up third party programs

To set up roundcube to be able to change the passwords with the password plugin you must use the next query:

$rcmail_config['password_query'] = 'UPDATE mail_mailbox mb INNER JOIN mail_domain md ON mb.mail_domain_id = md.id INNER JOIN domain d ON md.domain_id = d.id SET mb.password=%p WHERE mb.username=%l AND mb.password=%o AND d.domain=%d';

Updating the panel (MAKE BACKUPS FIRST!!)

Get the latest version of the code

git pull

Install the latest version of the dependencies

./composer.phar install

Update the database

php app/main/console doctrine:schema:update --force

And install the assets

php app/main/console assets:install --symlink

Commands

ACSPanel comes with some commands to make admin tasks, go to commands

Setting up services to automatic apply panel settings

Apache: Copy the script tools/acspanel-srv-apache2-reboot to each Apache2 server and give execution permission to the script. Change the panel database access details and add to crontab. Create a file in /etc/cron.d/ folder with the next contents:

* *     * * *   root    /usr/local/sbin/acspanel-srv-apache2-reboot

Change the route to your script location

API

Dynamic DNS API call

ACSPanel comes with RESTful API, at the moment only some calls are supported.

There's a ineteresting API call to update DNS record and be able to have a Dynamic DNS, like services as DynDNS or noip.

You should send GET request to the next URL with the hostname parameter at least, if you not provide myip this is deduced from the request of the machine calling the endpoint.

http://username:password@panel.url/nic/update?hostname=yourhostname&myip=ipaddress

What's inside?

Symfony2 comes pre-configured with the following bundles:

FrameworkBundle - The core Symfony framework bundle
SensioFrameworkExtraBundle - Adds several enhancements, including template and routing annotation capability
DoctrineBundle - Adds support for the Doctrine ORM
TwigBundle - Adds support for the Twig templating engine
SecurityBundle - Adds security by integrating Symfony's security component
SwiftmailerBundle - Adds support for Swiftmailer, a library for sending emails
MonologBundle - Adds support for Monolog, a logging library
AsseticBundle - Adds support for Assetic, an asset processing library
JMSSecurityExtraBundle - Allows security to be added via annotations
JMSDiExtraBundle - Adds more powerful dependency injection features
WebProfilerBundle (in dev/test env) - Adds profiling functionality and the web debug toolbar
SensioDistributionBundle (in dev/test env) - Adds functionality for configuring and working with Symfony distributions
SensioGeneratorBundle (in dev/test env) - Adds code generation capabilities
AcmeDemoBundle (in dev/test env) - A demo bundle with some example code

And ACSPanel adds the following Bundles:

FOSUserBundle - Adds the user authentication and administration.
StofDoctrineExtensionsBundle - Adds loggable support to entities.
KnpMenuBundle - Adds the menu generation system.
LiipThemeBundle - Adds the themes support.
CraueFormFlowBundle - Used in add hosting form flow.
GregwarFormBundle
KnpPaginatorBundle
DoctrineFixturesBundle

Enjoy!

acs / acspanel-core

Maintainers

Details