Getting Started With Sympl: Difference between revisions
m (Kelduum moved page Get Started to Getting Started With Sympl) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Sympl is designed to be easy to use and low maintenance, but there are a few things to be aware of. | Sympl is designed to be easy to use and low maintenance, but there are a few things to be aware of. | ||
== Using the <code>root</code> User == | ==About Users== | ||
Once Sympl is installed, your system with have a new user called <code>sympl</code>, who should be used to manage the configuration of Sympl. | |||
If you used the [[Installing Sympl#Automatic Install|install script]], the <code>sympl</code> user will have a temporary password set which can be found by running <code>less ~/README_SYMPL.txt</code>. | |||
If you haven't done so already, you should change the password as soon as possible with the command <code>passwd sympl</code>. | |||
You may want to consider using SSH keys rather than logging in with a password, however you will still need a password for <code>[[sudo]]</code> access. | |||
===Using the system <code>root</code> User=== | |||
Where possible, Sympl discourages you from using the <code>root</code> user when logging in and making any configuration changes. | Where possible, Sympl discourages you from using the <code>root</code> user when logging in and making any configuration changes. | ||
This mainly applies to the <code>/srv/</code> directory and the firewall configuration in <code>/etc/sympl/firewall/</code>. | This mainly applies to the <code>/srv/</code> directory and the firewall configuration in <code>/etc/sympl/firewall/</code>. | ||
If a directory in <code>/srv/</code> is owned by a system user (ie: root, or a user with a UID lower than 1000), then it will typically be ignored. | If a directory in <code>/srv/</code> is owned by a system user (ie: <code>root</code>, or a user with a UID lower than 1000), then it will typically be ignored. | ||
If you do need elevated permissions for some action, then <code>[[sudo]]</code> is available to the <code>sympl</code> user. | If you do need elevated permissions for some action, then <code>[[sudo]]</code> is available to the <code>sympl</code> user. | ||
== Manual Configuration Changes == | ===The MySQL <code>root</code> User=== | ||
Similarly, the [[MySQL]] root user should not be needed in 99.9% of cases. If you want to create a new database and user for a site, you can use the command <code>sympl create mysql '''''databasename'''''</code> and Sympl will handle it for you and tell you the password. | |||
A user named <code>sympl</code> with effectively the same permissions was created when Sympl was installed, and you can access the MySQL command line directly with the <code>mysql</code> command. However, if you need it the password for the <code>sympl</code> user in MySQL, it can be found in <code>/home/sympl/mysql_password</code>. | |||
==Manual Configuration Changes== | |||
If a configuration file has been generated by Sympl and is then edited by something else, it generally won't be modified by Sympl again. If this is the case, there will be a comment at the top of the file. | If a configuration file has been generated by Sympl and is then edited by something else, it generally won't be modified by Sympl again. If this is the case, there will be a comment at the top of the file. | ||
== This Wiki == | ==Using This Wiki== | ||
This wiki is designed as a one-stop location for all documentation for Sympl, and is aimed at a wide range of user skill levels. | This wiki is designed as a one-stop location for all documentation for Sympl, and is aimed at a wide range of user skill levels. | ||
When reading the guides here, and commands, files, directories and others are in <code>plain fixed-width text</code>, with variables (elements you should change when typing something) are written in <code>'''''bold italic fixed-width text'''</code>, | When reading the guides here, and commands, files, directories and others are in <code>plain fixed-width text</code>, with variables (elements you should change when typing something) are written in <code>'''''bold italic fixed-width text'''''</code>'', '' | ||
[[Category: | If you can't find what you need here or something isn't clear, please [https://forum.sympl.host post on the forum] and let us know! | ||
[[Category:Basic Administration]] | |||
Latest revision as of 15:32, 21 August 2020
Sympl is designed to be easy to use and low maintenance, but there are a few things to be aware of.
About Users
Once Sympl is installed, your system with have a new user called sympl, who should be used to manage the configuration of Sympl.
If you used the install script, the sympl user will have a temporary password set which can be found by running less ~/README_SYMPL.txt.
If you haven't done so already, you should change the password as soon as possible with the command passwd sympl.
You may want to consider using SSH keys rather than logging in with a password, however you will still need a password for sudo access.
Using the system root User
Where possible, Sympl discourages you from using the root user when logging in and making any configuration changes.
This mainly applies to the /srv/ directory and the firewall configuration in /etc/sympl/firewall/.
If a directory in /srv/ is owned by a system user (ie: root, or a user with a UID lower than 1000), then it will typically be ignored.
If you do need elevated permissions for some action, then sudo is available to the sympl user.
The MySQL root User
Similarly, the MySQL root user should not be needed in 99.9% of cases. If you want to create a new database and user for a site, you can use the command sympl create mysql databasename and Sympl will handle it for you and tell you the password.
A user named sympl with effectively the same permissions was created when Sympl was installed, and you can access the MySQL command line directly with the mysql command. However, if you need it the password for the sympl user in MySQL, it can be found in /home/sympl/mysql_password.
Manual Configuration Changes
If a configuration file has been generated by Sympl and is then edited by something else, it generally won't be modified by Sympl again. If this is the case, there will be a comment at the top of the file.
Using This Wiki
This wiki is designed as a one-stop location for all documentation for Sympl, and is aimed at a wide range of user skill levels.
When reading the guides here, and commands, files, directories and others are in plain fixed-width text, with variables (elements you should change when typing something) are written in bold italic fixed-width text,
If you can't find what you need here or something isn't clear, please post on the forum and let us know!