SOS Documentation
This page explains where to find help, what information is useful when reporting a problem and how to contact us about a potential security concern.
Before contacting support
The SOS documentation covers the most common setup, testing and troubleshooting questions.
Before contacting support, you may find the answer in:
- Getting Started with SOS;
- Set Up Your Critical Error Page;
- Test SOS Safely;
- How SOS Works;
- Developer Tools; or
- Troubleshooting SOS.
Checking Developer Tools before contacting support can also provide useful evidence about the current SOS installation.
Get support
For help with SOS, email:
Please describe the problem as clearly as possible so that we can understand what you were trying to do and what happened.
What information should I include?
Useful information can include:
- the SOS version;
- your WordPress version;
- your PHP version;
- what you were trying to do;
- what you expected to happen;
- what actually happened;
- whether the problem can be reproduced;
- the relevant Developer Tools status; and
- relevant error-log information with sensitive information removed.
If the problem involves the optional Geneva connection, information such as the connection status or HTTP status shown in Developer Tools may also be useful.
Protect your credentials
Do not email:
- WordPress administrator passwords;
- hosting or control-panel passwords;
- database credentials;
- FTP or SFTP passwords;
- API secrets;
- private keys; or
- other sensitive access credentials.
If further investigation genuinely requires additional access or information, that should be discussed separately rather than included unnecessarily in the initial request.
Report a potential security concern
If you believe you have found a potential security vulnerability in SOS, please report it responsibly to apluskdesign.
Email:
Use a clear subject line such as:
SOS Security Report
Please provide enough information for us to understand and investigate the issue, including where appropriate:
- the SOS version affected;
- the WordPress and PHP versions used during testing;
- a clear description of the potential vulnerability;
- the steps required to reproduce it;
- what you expected to happen;
- what actually happened; and
- any relevant technical evidence that can be shared safely.
Please report security issues responsibly
If you believe you have identified a genuine security vulnerability, please give apluskdesign a reasonable opportunity to investigate the report before publishing detailed information that could unnecessarily expose other SOS users.
Please do not use a suspected vulnerability to access, modify, damage or obtain information from websites or systems that you do not own or have explicit permission to test.
What can SOS support help with?
apluskdesign can help with questions relating to SOS itself, including:
- installing and configuring SOS;
- the Critical Error Page;
- the controlled fatal test;
- Developer Tools statuses;
- SOS-owned drop-in behaviour;
- the resilience profile;
- the optional Geneva connection; and
- suspected SOS bugs or security concerns.
Problems outside SOS
A Critical Error Page can appear because another part of the WordPress website has encountered a fatal error.
SOS displaying correctly does not mean SOS caused that underlying problem.
We may be able to help explain the evidence provided by SOS, but problems involving another plugin, theme, hosting environment, custom code or WordPress itself may need to be investigated by the relevant developer, provider or support service.
WordPress.org support
SOS is distributed through the WordPress Plugin Directory.
Once the public WordPress.org listing and support forum are available, users may also use the official SOS support area on WordPress.org for appropriate plugin questions.
Do not publish passwords, credentials, private server information or other sensitive information in a public support forum.
Support SOS
SOS is available free of charge.
If you find SOS useful and would like to support its continued development, you can buy apluskdesign a coffee.
Supporting SOS is entirely optional and does not unlock features or affect the support available to you.
Thank you for helping improve SOS
Useful bug reports, clear support questions and responsible security reports all help make SOS better for the WordPress community.
If something does not seem right, we would rather know about it.
