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...") Tag: visualeditor |
No edit summary Tag: visualeditor |
||
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. | ||
Line 8: | Line 10: | ||
Updates the Sympl packages. to the latest versions available. | Updates the Sympl packages. to the latest versions available. | ||
== Web == | ==Web== | ||
<code>sympl web audit</code> | <code>sympl web audit</code> | ||
Line 19: | Line 21: | ||
<code>sympl web destroy example.com</code> | <code>sympl web destroy example.com</code> | ||
== Database == | ==Database== | ||
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 database</code> | <code>sympl audit database</code> | ||
Lists the databases and database users. | Lists the databases and database users. | ||
=== Create === | ===Create=== | ||
<code>sympl create database '''''example'''''</code> | <code>sympl create database '''''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 database '''''example'''''</code> | <code>sympl disable database '''''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 database '''''example'''''</code> | <code>sympl enable database '''''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 database '''''example'''''</code> | <code>sympl destroy database '''''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 mailboxes is not yet implemented. | Functionality for managing mailboxes 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]] |
Revision as of 10:30, 20 May 2020
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.
sympl update
Updates the Sympl packages. to the latest versions available.
Web
sympl web audit
sympl web create example.com
sympl web enable example.com
sympl web disable example.com
sympl web destroy example.com
Database
Admins can create, enable, disable and destroy databases easily using the Sympl command line.
Audit
sympl audit database
Lists the databases and database users.
Create
sympl create database 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 disable database 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 enable database example
Enables the database user with the name example
. This restores the user access to the database.
Destroy
sympl destroy database 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 mailboxes is not yet implemented.
Functionality for managing mailboxes is not yet implemented.
DNS
Functionality for managing DNS is not yet implemented.