mirror
/
sitespeed.io
mirror of https://github.com/sitespeedio/sitespeed.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: make it more clear on what needs to be updated

This commit is contained in:
soulgalore 2024-06-04 12:43:04 +02:00
parent c569774771
commit 1364bb1f2e
1 changed files with 17 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/documentation/onlinetest/index.md
View File

@ -327,17 +327,17 @@ If you also use MinIO, make sure to configure how long the data will be stored.
Here's a checklist of things to consider when pushing to production:
1. **Change all the default passwords**:
- Do this for Redis, PostgreSQL, Admin, and Basic Auth.
2. **Limit your instance**:
- Do this for Redis, PostgreSQL, Admin, Minio (or what you use) and Basic Auth.
2. **Change settings for where you upload your result**
- Remember to change the [default settings](https://github.com/sitespeedio/onlinetest/blob/main/server/config/sitespeed.json) on where you upload the data and how you access it.
3. **Limit your instance**:
- Use Basic Auth for adding tests through the web GUI.
- Set a secret key for adding tests through the API.
- Use a regular expression that needs to match the domain you want to test.
- Disable search.
- Disable adding tests through the web GUI.
3. **Data retention**:
- If you use S3, make sure to configure how long the data will be kept.
4. **Data retention**:
- If you use S3 (or Minio), make sure to configure how long the data will be kept.
- Add a job to your PostgreSQL database to remove data older than X days. You can find an example script [here](https://github.com/sitespeedio/onlinetest/blob/main/server/database/delete/delete.sql).
# Using the API
@ -352,34 +352,23 @@ There are two parameters that you need to use:
You also have the following options:
- `--api.key`
- The API key to use. You configure the key in the server configuration.
- `--api.key` - The API key to use. You configure the key in the server configuration.
- `--api.action`
- The type of API call you want to make:
- `add`: Add a test.
- `addAndGetResult`: Add a test and wait for the result.
- `get`: Get the result of a test.
- `--api.action` - The type of API call you want to make:
- `add`: Add a test.
- `addAndGetResult`: Add a test and wait for the result.
- `get`: Get the result of a test.
- To get the result, make sure you add the ID using `--api.id`.
- [choices: "add", "addAndGetResult", "get"] [default: "addAndGetResult"]
- `--api.silent`
- Set to `true` if you do not want to log anything from the communication between the API and the server.
- [boolean] [default: false]
- `--api.silent` - Set to `true` if you do not want to log anything from the communication between the API and the server.
- `--api.port`
- The port for the API.
- `--api.port` - The port for the API.
- `--api.id`
- The ID of the test. Use it when you want to get the test result.
- [string]
- `--api.id` - The ID of the test. Use it when you want to get the test result.
- `--api.label`
- Add a label to your test.
- [string]
- `--api.label` - Add a label to your test.
- `--api.priority`
- The priority of the test. Highest priority is 1. The default is 10.
- `--api.priority` - The priority of the test. Highest priority is 1. The default is 10.
- `--api.json`
- Output the result as JSON.
- `--api.json` - Output the result as JSON.