Simple Groupware Administration: System task page
The System task page contains all kinds of administrative tasks and can only be accessed be the super administrator. Therefore, login as super administrator and navigate to "/Workspace/System".
Web File Browser
The Web File Browser offers you a web-based file browser. You can make changes to the Simple Groupware folder and its sub-folders. E.g. you can use it to upload files into the import folder or change source files. The functionality is similar to an FTP account, but it is running under the Apache user.
SYS Console
The SYS Console offers you to run command-line programs directly in the browser. Like a terminal you see the output of a command. Important administrative commands are listed in a table at the end of the page. The functionality is similar to a terminal.
SQL Console
The SQL Console offers you to run SQL queries directly in the browser. Database selection and authentication is done automatically. Several keyboard shortcuts make it faster to run the most common queries.
PHP Console
The PHP Console offers you to directly execute PHP without uploading any files. The code is directly executed in the window, the result is presented in the same window.
Switch maintenance mode
Active: All users (except super administrator) are rejected, logins are also rejected.
Inactive: All users can navigate, logins are allowed.
Backup current folder
Simple Groupware also offers an internal system backup method. With this method you can quickly create backups of special folders. Login as super administrator, go to a folder and click "Main menu / Backup current folder" in the top menu. This creates a backup of the current folder and all its sub-folders. The backup is stored in /Workspace/System/Backups. There you can restore and download the backup.
Caching in general
Caching is used to increase the page's speed when performing slow operations. To limit the size on your disk you can clear these cached from time to time. Instead of clearing them all separately you can run the setup again.
Note: To clean caches you need to be logged in as super administrator.
Clean cache
Cleans up the whole cache by deleting cache files older than 30 days (or 1 day depending on the cache type). Lockings for documents are removed if they are older than 1 day.
Output cache
To increase performance the templates for the tree, tabs, etc are cached. If you make changes to templates/*, empty the cache. Also the HTML-output is cached, so it is recommended to clean this up from time to time to avoid wasting too much disk space.
Also charts and resized images are being cached. If you make changes to the API or the templates, empty the cache.
Schema cache
To increase performance every module's schema is cached. If you make changes to the xml-functions, empty the cache.
Schema data cache
To increase performance when reading from external data sources, external files are cached. You should empty this cache once a month.
Debug-dir cache
When the database is unavailable all errors are logged to the debug cache (simple_cache/debug/*). Emptying this cache depends on you.
CMS cache
If pages have static page caching activated, the HTML files will be stored in the CMS cache. Every change of a CMS template will create new static files. You should empty this cache once a month.
IP cache
Every client activity is monitored with the IP address. You should empty this cache once a month.
Upload cache
Before files are moved to the data store (simple_store) they are kept in the cache (simple_cache). If the dataset is not finally committed to the database these files remain in simple_cache. You should empty this cache once a month.
E-mail cache
Attachments are copied to the cache before a user can download them. You should empty this cache once a month. Also folder contents and e-mail structures are cached using "schema data cache".
Locking cache
The locking cache contains a list of datasets that were edited recently and a list with all locked documents. You should remove all locks once a month.
Sessions cache
When a user is inactive for a longer time or finishes his session with the logout, the session data remains in the database. You should remove all sessions once a month.
Clear events
Delete all events from "/Workspace/System/Events". Contains events like PHP and database errors, user logins and other notifications.
Clear statistics
Delete all statistic datasets from "/Workspace/System/Statistics". Contains statistics for page requests, uploads, downloads, etc.
Clear trash
Deletes all contents completely from "/Workspace/System/Trash". The "Trash" folder contains all deleted folders, assets and attachments. When the trash gets emptied, accidental deletes can only be restored from a system backup.
Clear notifications
Deletes all entries from "/Workspace/System/Notifications" which are already delivered. The "Notifications" folder contains all notifications from appointments, tasks, birthdays, etc.
Optimize tables
This function analyzes and optimizes all tables in the database. Free data gets deleted and the query optimizer gets trained.
Rebuild search index
All datasets need to be indexed in the search index in order to be present in search results. This normally happens automatically, except when you're changing the contents directly in the database without Simple Groupware.
Run the setup again
This deletes the configuration in "<sgs-dir>/simple_store/config.php" and runs the setup again. The setup process clears all caches and all sessions and rebuilds the search index. If you made any changes in "change setup settings", these changes will be lost and need to be done again. That way the username / password for the super administrator will be cleared and needs to be set again.
Note: To run the setup again you'll need to be logged in as super administrator or delete the configuration file "<sgs-dir>/simple_store/config.php" on the local file system.
Change setup settings
Here you can tweak some settings and behaviors from Simple Groupware. Most important ones are authentication modes and database connection settings. E.g. if you need LDAP authentication, this is the right place to go.
Moreover, you can set the default theme, the standard mail footer, the default week start, etc. for details, see Configuration.
Running system tasks from cron
To run a system task automatically from cron, you can use:
*/5 * * * * curl -s -I "http(s)://your_server/sgs-dir/bin/index.php?action_sys=<action>&username=<admin-username>&password=<admin-password>" >>/tmp/cron_sgs_tasks.log
where <action> is:
- clean_events (Clear Events)
- clean_trash (Clear Trash)
- clean_statistics (Clear Statistics)
- clean_cache (Clean Cache)