Sympl Command Line
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.
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.
- Other than using
set, the function, action and target can be in any order.
setrequires two arguments immediately after it, the option and value.
- If more permissions are needed, you'll be prompted for your password.
destorywill only destroy something which has already been disabled.
Prints a help message with some example commands.
Updates the Sympl packages. to the latest versions available.
sympl web audit
Lists enabled and disabled sites.
sympl web create example.com
Creates a website for the domain 'example.com'. Public (website files) are stored under '/srv/example.com/public/htdocs'.
sympl web enable example.com
Enables a previously disabled site.
sympl web disable example.com
Disable a site.
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.
Admins can create, enable, disable and destroy databases easily using the Sympl command line.
sympl mysql audit
Lists the databases and database users.
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.
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.
sympl mysql enable example
Enables the database user with the name
example. This restores the user access to the database.
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.
sympl backup audit
Lists existing backups.
sympl backup create
Takes a new backup.
sympl backup enable
Enables automatic backups.
sympl backup disable
Disables automatic backups.
sympl backup destroy
Deletes the oldest backup and it's dependencies.
Functionality for managing FTP is not yet implemented.
Functionality for managing mailboxes is not yet implemented.
Functionality for managing DNS is not yet implemented.