chore: update install and license info for DEB/RPM
parent
6eaef81f77
commit
0ff4a23d89
|
|
@ -84,7 +84,7 @@ but the process of activating the license depends on the license type:
|
|||
1. Use the [`influxdb3 serve` command](/influxdb3/enterprise/reference/cli/influxdb3/serve/) to start the server.
|
||||
If the server doesn't find a license file or email address, the server prompts you
|
||||
to enter your email address.
|
||||
If you're [activating a trial or home license with Docker](#activate-a-trial-or-home-license-with-docker), include options to [skip the email prompt](#skip-the-email-prompt).
|
||||
If you're [activating a trial or home license with Docker](#activate-a-trial-or-home-license-with-docker) or [with DEB/RPM installs](#activate-a-trial-or-home-license-with-linux-packaging), include options to [skip the email prompt](#skip-the-email-prompt).
|
||||
2. The server prompts you to select a license type. Select `trial` or `home`.
|
||||
3. In the verification email from {{% product-name %}},
|
||||
click the button to verify your email address.
|
||||
|
|
@ -103,6 +103,15 @@ The license file is a JWT file that contains the license information.
|
|||
> verify your email address.
|
||||
> See the [Docker Compose example](?t=Docker+compose#start-with-license-email-and-compose).
|
||||
|
||||
> [!Important]
|
||||
> #### Activate a trial or home license with Linux packaging
|
||||
>
|
||||
> If you're starting a new {{% product-name %}} server that was installed via
|
||||
> DEB or RPM, you should use one of the methods to
|
||||
> [skip the email prompt](#skip-the-email-prompt). This ensures that the server
|
||||
> can generate the license file after you verify your email address.
|
||||
> See [DEB and RPM TOML](?t=DEB+and+RPM+TOML#start-with-license-email-and-toml).
|
||||
|
||||
#### Skip the email prompt
|
||||
|
||||
To skip the email prompt when starting the server, you can provide your email
|
||||
|
|
@ -187,6 +196,7 @@ existing license if it's still valid.
|
|||
[influxdb3 options](#)
|
||||
[Environment variables](#)
|
||||
[Docker compose](#start-with-license-email-and-compose)
|
||||
[DEB and RPM TOML](#start-with-license-email-and-toml)
|
||||
{{% /code-tabs %}}
|
||||
{{% code-tab-content %}}
|
||||
<!------------------------ BEGIN INFLUXDB3 CLI OPTIONS ------------------------>
|
||||
|
|
@ -255,6 +265,25 @@ Replace {{% code-placeholder-key %}}`${EMAIL_ADDRESS}`{{% /code-placeholder-key
|
|||
or a variable from your Compose `.env` file.
|
||||
<!------------------------- END DOCKER COMPOSE ------------------------->
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
<!------------------------ BEGIN DEB AND RPM TOML ------------------------>
|
||||
Adjust `/etc/influxdb3/influxdb3-enterprise.conf` to contain:
|
||||
|
||||
```toml
|
||||
license-email="example@email.com"
|
||||
```
|
||||
|
||||
then start the server with:
|
||||
|
||||
```bash
|
||||
# systemd (modern systems; see logs with 'journalctl --unit influxdb3-{{< product-key >}}')
|
||||
systemctl start influxdb3-enterprise
|
||||
|
||||
# SysV init (legacy systems; logs to /var/lib/influxdb3/influxdb3-{{< product-key >}}.log)
|
||||
/etc/init.d/influxdb3-enterprise start
|
||||
```
|
||||
<!------------------------ END DEB AND RPM TOML ------------------------>
|
||||
{{% /code-tab-content %}}
|
||||
{{< /code-tabs-wrapper >}}
|
||||
|
||||
### Start the server with your license file
|
||||
|
|
@ -263,6 +292,7 @@ or a variable from your Compose `.env` file.
|
|||
{{% code-tabs %}}
|
||||
[influxdb3 options](#)
|
||||
[Environment variables](#)
|
||||
[DEB and RPM TOML](#start-with-license-file-and-toml)
|
||||
{{% /code-tabs %}}
|
||||
{{% code-tab-content %}}
|
||||
<!------------------------ BEGIN INFLUXDB3 CLI OPTIONS ------------------------>
|
||||
|
|
@ -289,6 +319,33 @@ influxdb3 serve \
|
|||
```
|
||||
<!------------------------- END ENVIRONMENT VARIABLES ------------------------->
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
<!------------------------ BEGIN DEB AND RPM TOML ------------------------>
|
||||
Adjust `/etc/influxdb3/influxdb3-enterprise.conf` to contain:
|
||||
|
||||
```toml
|
||||
license-file="/etc/influxdb3/license-file.jwt"
|
||||
```
|
||||
|
||||
Ensure the license file has strict permissions that allow the database to read
|
||||
the file:
|
||||
|
||||
```bash
|
||||
chown root:influxdb3 /etc/influxdb3/influxdb3-enterprise.conf
|
||||
chmod 0640 /etc/influxdb3/influxdb3-enterprise.conf
|
||||
```
|
||||
|
||||
then start the server with:
|
||||
|
||||
```bash
|
||||
# systemd (modern systems; see logs with 'journalctl --unit influxdb3-{{< product-key >}}')
|
||||
systemctl start influxdb3-enterprise
|
||||
|
||||
# SysV init (legacy systems; logs to /var/lib/influxdb3/influxdb3-{{< product-key >}}.log)
|
||||
/etc/init.d/influxdb3-enterprise start
|
||||
```
|
||||
<!------------------------ END DEB AND RPM TOML ------------------------>
|
||||
{{% /code-tab-content %}}
|
||||
{{< /code-tabs-wrapper >}}
|
||||
|
||||
For more information about `influxdb3 serve` options, see the
|
||||
|
|
|
|||
|
|
@ -150,6 +150,7 @@ Install from the InfluxData repository by running the following commands using `
|
|||
Use `apt-get` to install {{< product-name >}} from the InfluxData repository:
|
||||
```
|
||||
```bash
|
||||
curl --silent --location -O https://repos.influxdata.com/influxdata-archive.key
|
||||
gpg --show-keys --with-fingerprint --with-colons ./influxdata-archive.key 2>&1 \
|
||||
| grep -q '^fpr:\+24C975CBA61A024EE1B631787C3D57159FC2F927:$' \
|
||||
&& cat influxdata-archive.key \
|
||||
|
|
@ -184,6 +185,62 @@ EOF
|
|||
{{% /expand %}}
|
||||
{{< /expand-wrapper >}}
|
||||
|
||||
#### TOML configuration (Linux)
|
||||
|
||||
The TOML configuration file for {{% product-name %}} when installed as a DEB or RPM is in `/etc/influxdb3/influxdb3-{{< product-key >}}` and initial install configures:
|
||||
|
||||
* [object-store](/influxdb3/{{< product-key >}}/reference/config-options/#object-store) to `file`
|
||||
* [data-dir](/influxdb3/{{< product-key >}}/reference/config-options/#data-dir) to `/var/lib/influxdb3/data`
|
||||
* [plugin-dir](/influxdb3/{{< product-key >}}/reference/config-options/#plugin-dir) to `/var/lib/influxdb3/plugins`
|
||||
* [node-id](/influxdb3/{{< product-key >}}/reference/config-options/#node-id) to `primary-node`
|
||||
{{% show-in "enterprise" %}}
|
||||
* [cluster-id](/influxdb3/{{< product-key >}}/reference/config-options/#cluster-id) to `primary-cluster`
|
||||
* [mode](/influxdb3/{{< product-key >}}/reference/config-options/#mode) to `all`
|
||||
|
||||
> [!Note]
|
||||
> {{% product-name %}} also requires configuring license information before the
|
||||
> database will start. See [Activate a license](/influxdb3/{{< product-key >}}/admin/license/#activate-a-license) for more information.
|
||||
{{% /show-in %}}
|
||||
|
||||
#### Run as a system service (Linux)
|
||||
|
||||
{{% product-name %}} DEB and RPM installs include service files for running as
|
||||
a managed system service on Linux:
|
||||
|
||||
- **systemd**: For modern Linux distributions
|
||||
- **SysV init**: For legacy system compatibility
|
||||
|
||||
On `systemd` systems, the `influxdb3-{{< product-key >}}` unit file is
|
||||
`enabled` on install, but the unit is not started in order to allow
|
||||
configuration. To start the database:
|
||||
|
||||
```bash
|
||||
# start the service
|
||||
systemctl start influxdb3-{{< product-key >}}
|
||||
|
||||
# see status
|
||||
systemctl status influxdb3-{{< product-key >}}
|
||||
|
||||
# see logs
|
||||
journalctl --unit influxdb3-{{< product-key >}}
|
||||
```
|
||||
|
||||
On SysV init systems, `influxdb3-{{< product-key >}}` is disabled on install
|
||||
and can be enabled by adjusting `/etc/default/influxdb3-{{< product-key >}}` to
|
||||
contain `ENABLED=yes`. To start the database:
|
||||
|
||||
```bash
|
||||
# start the database
|
||||
/etc/init.d/influxdb3-{{< product-key >}} start
|
||||
|
||||
# see status
|
||||
/etc/init.d/influxdb3-{{< product-key >}} status
|
||||
|
||||
# see logs
|
||||
tail -f /var/lib/influxdb3/influxdb3-{{< product-key >}}.log
|
||||
```
|
||||
|
||||
|
||||
### Verify the installation
|
||||
|
||||
After installing {{% product-name %}}, enter the following command to verify
|
||||
|
|
@ -200,14 +257,6 @@ If your system doesn't locate `influxdb3`, then `source` the configuration file
|
|||
source ~/.zshrc
|
||||
```
|
||||
|
||||
### Run as a system service (Linux)
|
||||
|
||||
{{% product-name %}} includes service files for running as a managed system service on Linux:
|
||||
|
||||
- **systemd**: For modern Linux distributions
|
||||
- **SysV init**: For legacy system compatibility
|
||||
|
||||
Service files are included in the Linux binary downloads.
|
||||
For more information, see the [release notes for v3.8.0](/influxdb3/corerelease-notes/#v380).
|
||||
|
||||
{{% show-in "enterprise" %}}
|
||||
|
|
|
|||
Loading…
Reference in New Issue