GUIDELINES.TXT

GUIDELINES.TXT: Defines the development guidelines of this repository.


Filenames Guidelines
=====================

Contrib File Format:
--------------------
installer-contrib-{+name}-{+version}-{+repoType}-{appserver}-{appserver_version}-{database}-{database_version}-{appRuntime}-{appRuntime_version}-{other}.conf

Example:
installer-contrib-lemp-nginx-osrepo-mysqlserver-5.7-php-7.2-phpfpm.conf


Apps File Format:
-----------------
{+name}-{+version}-{+repoType}-{appserver}-{appserver_version}-{database}-{database_version}-{appRuntime}-{appRuntime_version}

Example:
openvpn-2.6-offisrc
phpmyadmin-4.1.6-localsrc
phpmyadmin-latest-offisrc
magento-2.3.0-offirepo-nginx-mysqlserver-5.7-php-7.2


Service File Format:
--------------------
{+name}-{+version}-{+repoType}

Example:
mongodb-3.2-offirepo
docker-latest-offirepo
docker-1.3-offirepo
pureftpd-latest-osrepo


Variables Explained:
----------------------

+:
must be included variable

name:
Official name of the service, no dash

version:
{specific version number} (example: 1.2, 3.2, 3.23-3, etc.)
latest

repoType:
osrepo - Operating System built-in repository
offirepo - Officeial Vendor repository
offisrc - Official Vendor source
offibin - Official Binary
localsrc - Local file uploaded to this repository


Development Guidelines
======================

- Use only curl to download files (do not use wget).

- Scripts ends with an exit code based on the success or failure of the script.

- Scripts must includes the startup.sh file.

- Make sure you add dependencies tags and tagging at the end of the script for depedencies.

- System envrionment varialbes are always CAPITAL LETTERS.