Commit 29e8e9ac authored by Carlos Torres's avatar Carlos Torres

Adding new parameters: customer_id and backup_config_secret

parent 0ecbcd6a
Pipeline #10081 passed with stage
in 1 minute
......@@ -29,6 +29,23 @@ The command creates an authentication token linked to your username. <b>Write do
<!-- If you lost the token and need to recover it, you can have it sent to your mail with [a simple one-line command](https://docs.accelerator.shimmercat.com/faq/faq/#i-forgot-my-token-what-to-do). You can use your trial authentication token for two weeks to try it out for your domains. After a week the token will be disabled, but it is possible to enable everything again if you decide to continue using the services. -->
- - -
## Get your customer id
Use the curl command below to to get your customer id.
```
$ curl -v -X GET https://accelerator.shimmercat.com/presentation-api/v1/customer/ -H 'Authorization: Token <your_authentication_token>'
```
- - -
## Get your backup config secret
Use the curl command below to to get your backup config secret.
```
$ curl -v -X GET https://accelerator.shimmercat.com/presentation-api/v1/customer/backup-config-secret/ -H 'Authorization: Token <your_authentication_token>'
```
- - -
<details open class="warning"> <!-- Classes: note, danger, settings, admonition example, warning classes, success, -->
<summary>Three possible approaches</summary>
......
......@@ -108,6 +108,8 @@ Remember to edit the fields according to your details:
amqp_server_url: amqp.staging.c.shimmercat.com
amqp_vhost: skyloft
api_access_token: <your_authentication_token> # Received in the first step of the getting started tutorial
customer_id: <your_customer_id> # Received in the first step of the getting started tutorial
backup_config_secret: <your_backup_config_secret> # Received in the first step of the getting started tutorial
deployment_site_long_name: <your_name16> # Update this value with the value of your deployment site's `name16` you will create on the next step
deployment_site_long_secret: <your_secret16> # Update this value with the value of your deployment site's `secret16` you will create on the next step
enable_bots_blocking: false
......
......@@ -115,6 +115,8 @@ Below are descriptions of the variables that can be configured in the file `grou
| `domains` | A list of all domains that will be served by ShimmerCat for all deployments.|
| `origin_cdn_host` | In case you are creating a domain to be used as an image CDN, this would be the origin of the images.|
| `api_access_token`| The <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started.html#create-an-authentication-token" target="_blank">authentication token</a> received in the first step of the getting started tutorial.|
| `customer_id`| The <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started.html#get_an_customer_id" target="_blank">customer id</a> received in the first step of the getting started tutorial.|
| `backup_config_secret`| The <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started.html#get_your_backup_config_secret" target="_blank">backup config secret</a> received in the first step of the getting started tutorial.|
| `deployment_tags` | A comma separated string, e.g `"shimmercat,test"`, to identify deployments |
| `installers_dir` | Directory on the server where the executables to be installed will be uploaded. |
| `haproxy_auth_pass` | A password to haproxy that also the haproxy exporter will use. |
......
......@@ -114,6 +114,9 @@ Below are descriptions of the variables that can be configured in the file `grou
| `domains` | A list of all domains that will be served by ShimmerCat for all deployments.|
| `origin_cdn_host` | In case you are creating a domain to be used as an image CDN, this would be the origin of the images.|
| `api_access_token`| The <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started.html#create-an-authentication-token" target="_blank">authentication token</a> received in the first step of the getting started tutorial.|
| `customer_id`| The <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started.html#get_an_customer_id" target="_blank">customer id</a> received in the first step of the getting started tutorial.|
| `backup_config_secret`| The <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started.html#get_your_backup_config_secret" target="_blank">backup config secret</a> received in the first step of the getting started tutorial.|
| `deployment_tags` | A comma separated string, e.g `"shimmercat,test"`, to identify deployments |
| `deployment_tags` | A comma separated string, e.g `"shimmercat,test"`, to identify deployments |
| `installers_dir` | Directory on the server where the executables to be installed will be uploaded. |
| `haproxy_auth_pass` | A password to haproxy that also the haproxy exporter will use. |
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment