Skip to content

Commit

Permalink
/content/products/doltlab/installation.md: update installation instru…
Browse files Browse the repository at this point in the history 
…ctions
  • Loading branch information
@coffeegoddd
coffeegoddd committed Apr 2, 2024
1 parent 4d5b5c4 commit 5c5fd20
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions content/products/doltlab/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,47 +119,49 @@ Inside DoltLab < `v2.1.0`, in the unzipped `doltlab` directory, you'll find the
`installer`, introduced in DoltLab `v2.1.0` is used for configuring a DoltLab instance. This tool will create the appropriate assets for you to run DoltLab, based on the arguments you supply to the `installer`.

`templates` contains email templates used by `doltlabapi` to send automated emails to users of your DoltLab instance. You can customize emails by
editing these files before starting your DoltLab instance. For more information on the contents of these files and how to change them, see the [Customize automated emails](./administrator.md#customize-automated-emails) section of the Administrator guide.
editing these files before starting your DoltLab instance. For more information on the contents of these files and how to change them, see the [Customize automated emails](./administrator.md#customize-automated-emails) section of the Administrator guide. In DoltLab >= `v2.1.0` these files are no longer shipped with the DoltLab zip. Instead, `installer` will generate these files if `--custom-email-templates` is used (DoltLab Enterprise only).

`envoy.tmpl` is an template file used to create the [Envoy](https://www.envoyproxy.io/) proxy configuration file called `envoy.yaml`.
`envoy.tmpl` is an template file used to create the [Envoy](https://www.envoyproxy.io/) proxy configuration file called `envoy.yaml`. In DoltLab >= `v2.1.0` this file is not included, as a single `envoy.json` file will be generated by the `installer` instead.

`envoy-tls.tmpl` is included in DoltLab >= `v1.0.6` and is used to create an `envoy.yaml` file that uses TLS.
`envoy-tls.tmpl` is included in DoltLab >= `v1.0.6` and is used to create an `envoy.yaml` file that uses TLS. In DoltLab >= `v2.1.0` this file is not included, as a single `envoy.json` file will be generated by the `installer` instead.

`gentokenenckey`, short for "generate token encryption key" is a binary used to generate token encryption keys used by DoltLab. The code is available [here](https://gist.github.com/coffeegoddd/9b1acb07baaa72c8173a2e7b11dacb80).
`gentokenenckey`, short for "generate token encryption key" is a binary used to generate token encryption keys used by DoltLab. The code is available [here](https://gist.github.com/coffeegoddd/9b1acb07baaa72c8173a2e7b11dacb80). In DoltLab >= `v2.1.0` this tool is not included, as the `installer` will generate encryption keys for each service. They will be available in directories named for each service after the `installer` runs.

`config_loader` is a binary used to process the `admin-config.yaml` file, if one exists.
`config_loader` is a binary used to process the `admin-config.yaml` file, if one exists. In DoltLab >= `v2.1.0` this tool is not included, it is replaced by the `installer`.

`send_doltlab_deployed_event` is a binary that sends a single request to our metrics server, letting us track how many DoltLab instances get deployed each day. This information helps us properly fund and staff our DoltLab team. The source for this binary is [here](https://gist.github.com/coffeegoddd/cc1c7c765af56f6523bc5faffbc19e7a).
`send_doltlab_deployed_event` is a binary that sends a single request to our metrics server, letting us track how many DoltLab instances get deployed each day. This information helps us properly fund and staff our DoltLab team. The source for this binary is [here](https://gist.github.com/coffeegoddd/cc1c7c765af56f6523bc5faffbc19e7a). In DoltLab >= `v2.1.0` this tool is not included, it is replaced by the `installer`.

`smtp_connection_helper` is a binary used to help troubleshoot any issues your DoltLab instance might have when establishing a connection to your existing SMTP server. This tool uses similar code to DoltLab's email service and should successfully send a test email if the connection to the SMTP server was configured correctly. The source code for the tool is available [here](https://gist.github.com/coffeegoddd/66f5aeec98640ff8a22a1b6910826667) and basic instructions for using the tool are [here](./administrator.md#troubleshoot-smtp-connection).

`get_machine_id` is a binary used to determine the hardware ID of the DoltLab host, used only for DoltLab Enterprise.
`get_machine_id` is a binary used to determine the hardware ID of the DoltLab host, used only for DoltLab Enterprise. In DoltLab >= `v2.1.0` this tool is not included, it is replaced by the `installer`.

`gen_saml_key` is a binary used to generate a private key for configuring SAML single-sign-on, used only for DoltLab Enterprise.
`gen_saml_key` is a binary used to generate a private key for configuring SAML single-sign-on, used only for DoltLab Enterprise. In DoltLab >= `v2.1.0` this tool is not included, it is replaced by the `installer`.

`gen_saml_cert` is a binary used to generate a signing certificate for SAML single-sign-on, used only for DoltLab Enterprise.
`gen_saml_cert` is a binary used to generate a signing certificate for SAML single-sign-on, used only for DoltLab Enterprise. In DoltLab >= `v2.1.0` this tool is not included, it is replaced by the `installer`.

`gen_saml_certs.sh` is a script that uses `gen_saml_key` and `gen_saml_cert` to create a signing certificate for SAML single-sign-on, used only for DoltLab Enterprise. The script requires a single argument, the `common name` to use for the certificate.
`gen_saml_certs.sh` is a script that uses `gen_saml_key` and `gen_saml_cert` to create a signing certificate for SAML single-sign-on, used only for DoltLab Enterprise. The script requires a single argument, the `common name` to use for the certificate. In DoltLab >= `v2.1.0` this tool is not included, it is replaced by the `installer`.

`migrate_postgres_dolt.sh` is a script available in DoltLab `v1.0.0`+. Prior to DoltLab `v1.0.0`, DoltLab used PostgreSQL as its database. But now, starting with `v1.0.0`, DoltLab uses Dolt as its database. This script is used when upgrading from an older DoltLab instance to DoltLab `v1.0.0` and will copy the data from the existing, older DoltLab instance into the new Dolt database backing DoltLab `v1.0.0`. Please see [the guide](./administrator.md#upgrade-v080-v100) for using this script to copy existing data during upgrade.

`dolt_db_cli.sh` is a script available in DoltLab `v1.0.0`+, useful for restoring DoltLab's Dolt server from a backup.
`dolt_db_cli.sh` is a script available in DoltLab `v1.0.0`+, useful for restoring DoltLab's Dolt server from a backup. In DoltLab >= `v2.1.0` this script will be generated by the `installer` and located at `./doltlabdb/dolt_db_cli.sh`.

`shell-db.sh` is a script that will open a shell to your running DoltLab's database server. For DoltLab versions lower than `v1.0.0`, this database server is PostgreSQL. To use this script with those versions, supply the `POSTGRES_PASSWORD` value you set when starting DoltLab as the environment variable `PGPASSWORD`. A successful connection will display a `dolthubapi=#` prompt.
`shell-db.sh` is a script that will open a shell to your running DoltLab's database server. For DoltLab versions lower than `v1.0.0`, this database server is PostgreSQL. To use this script with those versions, supply the `POSTGRES_PASSWORD` value you set when starting DoltLab as the environment variable `PGPASSWORD`. A successful connection will display a `dolthubapi=#` prompt. In DoltLab >= `v2.1.0` this script will be generated by the `installer` and located at `./doltlabdb/shell-db.sh`.

For DoltLab `v1.0.0` and later, Dolt is the database server. To connect to it, supply the `DOLT_PASSWORD` environment variable value you set when starting DoltLab. A successful connection will display a `mysql>` prompt.

`docker-compose.yaml` is a complete [Docker Compose](https://docs.docker.com/compose/) configuration file that will spin up all the services required to run DoltLab.
`docker-compose.yaml` is a complete [Docker Compose](https://docs.docker.com/compose/) configuration file that will spin up all the services required to run DoltLab. In DoltLab >= `v2.1.0` this file is not included, but will be generated as a single `docker-compose.yaml` file by the `installer` instead.

`docker-compose-tls.yaml` is included in DoltLab >= `v1.0.6` and will spin up DoltLab using TLS.
`docker-compose-tls.yaml` is included in DoltLab >= `v1.0.6` and will spin up DoltLab using TLS. In DoltLab >= `v2.1.0` this file is not included, but will be generated as a single `docker-compose.yaml` file by the `installer` instead.

`start-doltlab.sh` is a helper script designed to quickly and easily start DoltLab. See the following section for more information about how to use this script.
`start-doltlab.sh` is a helper script designed to quickly and easily start DoltLab. See the following section for more information about how to use this script. In DoltLab >= `v2.1.0` this script is not included, but will be generated as a single `start.sh` file by the `installer` instead.

`prometheus.yaml` is a [Prometheus](https://prometheus.io/) configuration file that can be used for observing real-time DoltLab service metrics. Used for DoltLab Enterprise automated backups.
`stop.sh` is a script used to stop running a DoltLab instance. Only available in In DoltLab >= `v2.1.0`, this script is generated by the `installer`.

`prometheus-alert.rules` is an alert rules file used for sending emails to DoltLab admins in the event of a backup failure. Used for DoltLab Enterprise automated backups.
`prometheus.yaml` is a [Prometheus](https://prometheus.io/) configuration file that can be used for observing real-time DoltLab service metrics. Used for DoltLab Enterprise automated backups. In DoltLab >= `v2.1.0` this file is not included, but will be generated by the `installer` when automated backups are configured. It will be located at `./prometheus/prometheus.yaml`.

`alertmanager.yaml` is a [AlertManager](https://prometheus.io/docs/alerting/latest/alertmanager/) configuration file for sending email alerts to DoltLab admins based on Prometheus metrics. Used for DoltLab Enterprise automated backups.
`prometheus-alert.rules` is an alert rules file used for sending emails to DoltLab admins in the event of a backup failure. Used for DoltLab Enterprise automated backups. In DoltLab >= `v2.1.0` this file is not included, but will be generated by the `installer` when automated backups are configured. It will be located at `./prometheus/alert.rules`.

`alertmanager.yaml` is a [AlertManager](https://prometheus.io/docs/alerting/latest/alertmanager/) configuration file for sending email alerts to DoltLab admins based on Prometheus metrics. Used for DoltLab Enterprise automated backups. In DoltLab >= `v2.1.0` this file is not included, but will be generated by the `installer` when automated backups are configured. It will be located at `./alertmanager/alertmanager.yaml`.

<h1 id="start-doltlab"><ins>Step 3: Start DoltLab</ins></h1>

Expand Down

0 comments on commit 5c5fd20

Please sign in to comment.