ACSPanel (ACS Control Server Panel)
Welcome to ACSPanel - The server administration tool written in Symfony2
This document contains information on how to download, install, and start using ACSPanel.
- 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
- Admin theme, thanks to [AvanzuAdminThemeBundle][https://github.com/avanzu/AdminThemeBundle]
- Mobile front-end (Comming soon...):
- Wordpress farm: See PanelWordpressBundle
- API Restful, using [FOSRestBundle][https://github.com/FriendsOfSymfony/FOSRestBundle] and [NelmioApiDocBundle][https://github.com/nelmio/NelmioApiDocBundle] for the documentation.
- 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):
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 firstname.lastname@example.org:AltCtrlSupr/ACSPanel-Standard.git acspanel curl -sS https://getcomposer.org/installer | php php composer.phar install
Install using docker
docker run -d --name acspanel -v <parameters.yml-path>:/var/www/app/config/parameters.yml -p <your-exposed-port>:80 altctrlsupr/acspanel
You can also build your own docker image:
git clone email@example.com:AltCtrlSupr/ACSPanel-Standard.git acspanel cd acspanel
docker build --name <user>/acspanel .
And then you can run the image using the command avobe changing the image name for the one you choose.
To avoid permissions issues after executing console commands you should do the next
mkdir app/cache && mkdir app/logs (TODO: check this to be created with the initial files...) sudo setfacl -R -m u:www-data:rwX -m u:`whoami`:rwX app/cache app/logs sudo setfacl -dR -m u:www-data:rwx -m u:`whoami`:rwx app/cache app/logs
Setting up ACSPanel
You should create your own config_dev.yml, as the parameters you can take config_dev.yml.sample as example.
cp app/config/config_dev.yml.sample app/config/config_dev.yml
To install all the dependencies you have to execute composer command.
Then you are ready to create the acspanel basic schema executing the next command:
php app/console doctrine:schema:create
You can load some basic fixtures running next command, like basic groups and admin to start using the panel:
php app/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.
For the AvanzuAdminThemeBundle you should download its assets running the next command:
php app/console avanzu:admin:fetch-vendor
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/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 (DO BACKUPS FIRST!!)
Get the latest version of the code
Install the latest version of the dependencies
Update the database
php app/console doctrine:schema:update --force
And install the assets
php app/console assets:install --symlink
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
If you want to contribute you can open Issues on this github repository. Also you can donate to the next bitcoin address:
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.