Sympl Command Line: Difference between revisions
(Created page with "Sympl has an easy-to-use command line parser, which handles many of the day-to-day configuration tasks. Note that this feature is in beta, and as such, this functionality may...") |
(Added simple docs for 'sympl web *') |
||
(6 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Stub}} | |||
Sympl has an easy-to-use command line parser, which handles many of the day-to-day configuration tasks. | Sympl has an easy-to-use command line parser, which handles many of the day-to-day configuration tasks. | ||
Note that this feature is in beta, and as such, this functionality may change from time to time. | ''Note that this feature is in beta, and as such, this functionality may change from time to time.'' | ||
==Usage== | |||
Each command consists of | |||
sympl [function] [action] [target] | |||
Where function is one of: | |||
web, mail, mysql, dns, ftp, cron, backup or blank for the system itself. | |||
And action is one of: | |||
create, enable, disable, audit, update, destroy, set <item|option> <value> | |||
And target is: | |||
the domain/email address/database/etc. | |||
Useful things: | |||
* Other than using <code>set</code>, the function, action and target can be in any order. | |||
* <code>set</code> requires two arguments immediately after it, the option and value. | |||
* If more permissions are needed, you'll be prompted for your password. | |||
* <code>destory</code> will only destroy something which has already been disabled. | |||
==System== | |||
<code>sympl help</code> | |||
Prints a help message with some example commands. | |||
<code>sympl update</code> | <code>sympl update</code> | ||
Line 8: | Line 33: | ||
Updates the Sympl packages. to the latest versions available. | Updates the Sympl packages. to the latest versions available. | ||
== Web == | ==Web== | ||
===Audit=== | |||
<code>sympl web audit</code> | <code>sympl web audit</code> | ||
Lists enabled and disabled sites. | |||
===Create=== | |||
<code>sympl web create example.com</code> | <code>sympl web create example.com</code> | ||
Creates a website for the domain 'example.com'. Public (website files) are stored under '/srv/example.com/public/htdocs'. | |||
===Enable=== | |||
<code>sympl web enable example.com</code> | <code>sympl web enable example.com</code> | ||
Enables a previously disabled site. | |||
===Disable=== | |||
<code>sympl web disable example.com</code> | <code>sympl web disable example.com</code> | ||
Disable a site. | |||
===Destroy=== | |||
<code>sympl web destroy example.com</code> | <code>sympl web destroy example.com</code> | ||
== | Completely removes a site from Apache and deletes it from the directory structure. The site must be disabled before it can be destroyed. | ||
==MySQL== | |||
Admins can create, enable, disable and destroy databases easily using the Sympl command line. | Admins can create, enable, disable and destroy databases easily using the Sympl command line. | ||
=== Audit === | ===Audit=== | ||
<code>sympl audit | <code>sympl mysql audit</code> | ||
Lists the databases and database users. | Lists the databases and database users. | ||
=== Create === | ===Create=== | ||
<code>sympl create | <code>sympl mysql create '''''example'''''</code> | ||
Creates a database named <code>example</code>, along with a user of the same name with full access to only that database, and outputs the password. The password is also saved in a files with restricted access in the <code>/home/sympl directory</code> for future reference. | Creates a database named <code>example</code>, along with a user of the same name with full access to only that database, and outputs the password. The password is also saved in a files with restricted access in the <code>/home/sympl directory</code> for future reference. | ||
=== Disable === | ===Disable=== | ||
<code>sympl disable | <code>sympl mysql disable '''''example'''''</code> | ||
Disables the database user with the name <code>example</code>. This removes access to the database for the user, leaving the user and the database enabled. | Disables the database user with the name <code>example</code>. This removes access to the database for the user, leaving the user and the database enabled. | ||
=== Enable === | ===Enable=== | ||
<code>sympl enable | <code>sympl mysql enable '''''example'''''</code> | ||
Enables the database user with the name <code>example</code>. This restores the user access to the database. | Enables the database user with the name <code>example</code>. This restores the user access to the database. | ||
=== Destroy === | ===Destroy=== | ||
<code>sympl destroy | <code>sympl mysql destroy '''''example'''''</code> | ||
Permanently destroys the database and removes the user with the name <code>example</code>. As a safety measure, the database must be disabled first. | Permanently destroys the database and removes the user with the name <code>example</code>. As a safety measure, the database must be disabled first. | ||
== Backup == | ==Backup== | ||
=== Audit === | ===Audit=== | ||
<code>sympl backup audit</code> | <code>sympl backup audit</code> | ||
Lists existing backups. | Lists existing backups. | ||
=== Create === | ===Create=== | ||
<code>sympl backup create</code> | <code>sympl backup create</code> | ||
Takes a new backup. | Takes a new backup. | ||
=== Enable === | ===Enable=== | ||
<code>sympl backup enable</code> | <code>sympl backup enable</code> | ||
Enables automatic backups. | Enables automatic backups. | ||
=== Disable === | ===Disable=== | ||
<code>sympl backup disable</code> | <code>sympl backup disable</code> | ||
Disables automatic backups. | Disables automatic backups. | ||
=== Destroy === | ===Destroy=== | ||
<code>sympl backup destroy</code> | <code>sympl backup destroy</code> | ||
Deletes the oldest backup and it's dependencies. | Deletes the oldest backup and it's dependencies. | ||
== FTP == | ==FTP== | ||
Functionality for managing | Functionality for managing FTP is not yet implemented. | ||
== Mail == | ==Mail== | ||
Functionality for managing mailboxes is not yet implemented. | Functionality for managing mailboxes is not yet implemented. | ||
== DNS == | ==DNS== | ||
Functionality for managing DNS is not yet implemented. | Functionality for managing DNS is not yet implemented. | ||
[[Category: | [[Category:Reference]] |
Latest revision as of 10:19, 16 September 2022
This article is a Stub. You can help the Sympl Project by expanding it.
Sympl has an easy-to-use command line parser, which handles many of the day-to-day configuration tasks.
Note that this feature is in beta, and as such, this functionality may change from time to time.
Usage
Each command consists of
sympl [function] [action] [target]
Where function is one of:
web, mail, mysql, dns, ftp, cron, backup or blank for the system itself.
And action is one of:
create, enable, disable, audit, update, destroy, set <item|option> <value>
And target is:
the domain/email address/database/etc.
Useful things:
- Other than using
set
, the function, action and target can be in any order. set
requires two arguments immediately after it, the option and value.- If more permissions are needed, you'll be prompted for your password.
destory
will only destroy something which has already been disabled.
System
sympl help
Prints a help message with some example commands.
sympl update
Updates the Sympl packages. to the latest versions available.
Web
Audit
sympl web audit
Lists enabled and disabled sites.
Create
sympl web create example.com
Creates a website for the domain 'example.com'. Public (website files) are stored under '/srv/example.com/public/htdocs'.
Enable
sympl web enable example.com
Enables a previously disabled site.
Disable
sympl web disable example.com
Disable a site.
Destroy
sympl web destroy example.com
Completely removes a site from Apache and deletes it from the directory structure. The site must be disabled before it can be destroyed.
MySQL
Admins can create, enable, disable and destroy databases easily using the Sympl command line.
Audit
sympl mysql audit
Lists the databases and database users.
Create
sympl mysql create example
Creates a database named example
, along with a user of the same name with full access to only that database, and outputs the password. The password is also saved in a files with restricted access in the /home/sympl directory
for future reference.
Disable
sympl mysql disable example
Disables the database user with the name example
. This removes access to the database for the user, leaving the user and the database enabled.
Enable
sympl mysql enable example
Enables the database user with the name example
. This restores the user access to the database.
Destroy
sympl mysql destroy example
Permanently destroys the database and removes the user with the name example
. As a safety measure, the database must be disabled first.
Backup
Audit
sympl backup audit
Lists existing backups.
Create
sympl backup create
Takes a new backup.
Enable
sympl backup enable
Enables automatic backups.
Disable
sympl backup disable
Disables automatic backups.
Destroy
sympl backup destroy
Deletes the oldest backup and it's dependencies.
FTP
Functionality for managing FTP is not yet implemented.
Functionality for managing mailboxes is not yet implemented.
DNS
Functionality for managing DNS is not yet implemented.