kienan
/
AlternC
mirror of https://github.com/kienanstewart/AlternC.git
1
0
Fork 0
Code Issues Releases Wiki Activity

big enhancment of README for developers

This commit is contained in:
Benjamin Sonntag 2016-02-03 22:37:56 +01:00
parent d15a16ef23
commit eb84153885
2 changed files with 15 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -1,53 +1,36 @@
## AlternC: Hosting software suite
![](https://alternc.com/logo.png)
AlternC is a software suite helping system administrators in handling
Web Services management. It should be easy to install, based only on
OpenSource softwares.
## AlternC: Web and Email Hosting Software Suite
AlternC is a software helping system administrators to handle Web and Email services management. It should be easy to install, based only on free software.
This software consist of an automatic install and configuration system, a web control panel to manage hosted users and their web services such as domains, email accounts, ftp accounts, web statistics...
Technically, AlternC is based on Debian GNU/Linux distribution and it depends on other softwares such as Apache, Postfix,
Mailman (...). It also contains an API documentation so that users can easily customize their web desktop.
Technically, AlternC is based on Debian GNU/Linux distribution and it depends on other software such as Apache, Postfix, Dovecot, Mailman (...). It also contains an API documentation so that users can easily customize their web desktop.
This project native tongue is French. However, the packages are available at least in French and English.
## Documentation
[alternc.com](https://alternc.com)
## Installation
[To install AlternC, please follow our install documentation](https://alternc.com/Install-en)
For now, AlternC can be installed as a Debian package. This package
depends on other softs used by AlternC. Just add those lines to your
/etc/apt/sources.list file :
[Pour installer AlternC, merci de suivre la documentation d'installation](https://alternc.com/Install-fr)
```
deb http://debian.alternc.org/ stable main
```
## Developper information
then
* This software is built around a Debian package for Squeeze whose packaging instructions are located in [debian/](debian/) folder
* To **build the packages**, clone this repository in a Debian machine and use `debuild` or `dpkg-buildpackage` from source code root.
* If you want to **build it for Wheezy**, clone the source and patch it for Wheezy using [wheezy/patch.sh](wheezy/patch.sh) script. You'll be able to use dpkg-buildpackage to build the Wheezy version.
* If you want to **build it for Jessie**, clone the source and patch it for Wheezy using [wheezy/patch.sh](wheezy/patch.sh) script then patch it for Jessie using [jessie/patch.sh](jessie/patch.sh) script. You'll be able to use dpkg-buildpackage to build the Jessie version.
```
apt-get install mysql-server alternc alternc-ssl
```
* The web control panel pages written in php are located in [bureau/admin](bureau/admin) and the associated PHP classes doing the stuff are in [bureau/class](bureau/class).
You may download and install additionnal plugins after installing AlternC :
* alternc-api
* alternc-awstats
* alternc-mailman
* alternc-roundcube (webmail)
Let's go to the [developper page](http://alternc.com) for more information.
## License
AlternC is distributed under the GPL v2 or later license. See `COPYING`.
AlternC's translations (po files) are distributed under the Creative Commons
CC0 license. Don't participate to the translation if you don't agree to publish
your translation using that license.
AlternC's translations (po files) are distributed under the [Creative Commons CC0 license](https://creativecommons.org/publicdomain/zero/1.0/). Don't participate to the translation if you don't agree to publish your translations under that license.

6
debian/rules vendored
View File

@ -26,9 +26,3 @@ override_dh_install:
%:
dh $@
build-snapshot:
@echo "building a package based on the current snapshot (${VERSION})"
svn update || true
svn export . ../alternc-${VERSION}
cd ../alternc-${VERSION} && sed -i -e '1s/)/~svn${REV})/' debian/changelog && debuild