Skip to content

Commit b6f7181

Browse files
authored
Merge pull request #2886 from influxdata/rm-special-chars
Remove star special characters from code blocks
2 parents 8735b9a + bf8c40b commit b6f7181

File tree

36 files changed

+203
-203
lines changed

36 files changed

+203
-203
lines changed

content/enterprise_influxdb/v1.0/administration/upgrading.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,8 @@ bind-address = ""
203203
hostname = "enterprise-meta-01"
204204
205205
[enterprise]
206-
registration-enabled = true #✨
207-
registration-server-url = "http://<web_console_hostname>:3000" #✨
206+
registration-enabled = true
207+
registration-server-url = "http://<web_console_hostname>:3000"
208208
209209
[...]
210210
```

content/enterprise_influxdb/v1.0/guides/migration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,17 +125,17 @@ For the following settings in `/etc/influxdb/influxdb.conf`, set:
125125
* `auth-enabled` in the `[http]` section to true
126126
* `shared-secret` in the `[http]` section to your shared secret (you must manually add this setting for the Enterprise Web console to function)
127127

128-
```
128+
```toml
129129
# Change this option to true to disable reporting.
130130
reporting-disabled = false
131-
hostname="your-hostname" #
131+
hostname="your-hostname" # enter your server's hostname
132132
meta-tls-enabled = false
133133

134134
[enterprise]
135135

136136
registration-enabled = false
137137
registration-server-url = ""
138-
license-key = "<your_license_key>" #
138+
license-key = "<your_license_key>" # Enter your InfluxDB Enterprise license key
139139
license-path = ""
140140

141141
[meta]
@@ -151,13 +151,13 @@ dir = "/var/lib/influxdb/data"
151151
[http]
152152
enabled = true
153153
bind-address = ":8086"
154-
auth-enabled = true #
154+
auth-enabled = true # Set to 'true' to enable authentication
155155
log-enabled = true
156156
write-tracing = false
157157
pprof-enabled = false
158158
https-enabled = false
159159
https-certificate = "/etc/ssl/influxdb.pem"
160-
shared-secret = "long pass phrase used for signing tokens" #
160+
shared-secret = "long pass phrase used for signing tokens" # Enter your shared secret
161161

162162
[...]
163163

content/enterprise_influxdb/v1.0/introduction/data_node_installation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,28 +107,28 @@ Second, in `/etc/influxdb/influxdb.conf`, set:
107107

108108
> **Note:** `license-key` and `license-path` are mutually exclusive and one must remain set to the empty string.
109109
110-
```
110+
```toml
111111
# Change this option to true to disable reporting.
112112
# reporting-disabled = false
113113
# bind-address = ":8088"
114-
hostname="enterprise-data-0x" #
114+
hostname="enterprise-data-0x" # Set to the full hostname of the data node
115115

116116
[enterprise]
117117

118118
registration-enabled = false
119119
registration-server-url = ""
120-
license-key = "<your_license_key>" #✨ mutually exclusive with license-path
121-
license-path = "/path/to/readable/JSON.license.file" #✨ mutually exclusive with license-key
120+
license-key = "<your_license_key>" # Mutually exclusive with license-path
121+
license-path = "/path/to/readable/JSON.license.file" # Mutually exclusive with license-key
122122

123123
[meta]
124-
dir = "/var/lib/influxdb/meta" # data nodes do require a local meta directory
124+
dir = "/var/lib/influxdb/meta" # Data nodes require a local meta directory
125125

126126
[...]
127127

128-
[http] #✨
128+
[http]
129129
# enabled = true
130130
# bind-address = ":8086"
131-
auth-enabled = true #✨ this is recommended but not required
131+
auth-enabled = true # Set to 'true' to enable authentication. Recommended, but not required.
132132
# log-enabled = true
133133
# write-tracing = false
134134
# pprof-enabled = false
@@ -137,7 +137,7 @@ auth-enabled = true #✨ this is recommended but not required
137137
# https-private-key = ""
138138
# max-row-limit = 10000
139139
# max-connection-limit = 0
140-
shared-secret = "long pass phrase used for signing tokens" #
140+
shared-secret = "long pass phrase used for signing tokens" # Enter a shared secret
141141
# realm = "InfluxDB"
142142
```
143143

content/enterprise_influxdb/v1.0/introduction/meta_node_installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,16 +95,16 @@ Entering the IP or hostname alone will lead to errors.
9595

9696
> **Note:** `license-key` and `license-path` are mutually exclusive and one must remain set to the empty string.
9797
98-
```
98+
```toml
9999
reporting-disabled = false
100100
bind-address = ""
101-
hostname = "<enterprise-meta-0x>" #
101+
hostname = "<enterprise-meta-0x>" # Enter the full hostname of the meta node
102102

103103
[enterprise]
104-
registration-enabled = true #
105-
registration-server-url = "http://<web-console-server-IP>:3000" #
106-
license-key = "<your_license_key>" #✨ mutually exclusive with license-path
107-
license-path = "/path/to/readable/JSON.license.file" #✨ mutually exclusive with license-key
104+
registration-enabled = true # Set to 'true'
105+
registration-server-url = "http://<web-console-server-IP>:3000" # Web console server hostname
106+
license-key = "<your_license_key>" # Mutually exclusive with license-path
107+
license-path = "/path/to/readable/JSON.license.file" # Mutually exclusive with license-key
108108
```
109109

110110
### 3. Start the meta node

content/enterprise_influxdb/v1.0/introduction/web_console_installation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,17 @@ In `/etc/influx-enterprise/influx-enterprise.conf`, set:
6060
6161
* `shared-secret` in the `[influxdb]` section to the same pass phrase that you used in your data node configuration files
6262

63-
```
64-
url = "http://<your_server's_IP_address>:3000" #
63+
```toml
64+
url = "http://<your_server's_IP_address>:3000" # Enter node URL
6565

6666
hostname = "localhost"
6767
port = "3000"
6868

69-
license-key = "<your_license_key>" #✨ mutually exclusive with license-file
70-
license-file = "/path/to/readable/JSON.license.file" #✨ mutually exclusive with license-key
69+
license-key = "<your_license_key>" # Mutually exclusive with license-file
70+
license-file = "/path/to/readable/JSON.license.file" # Mutually exclusive with license-key
7171

7272
[influxdb]
73-
shared-secret = "long pass phrase used for signing tokens" #
73+
shared-secret = "long pass phrase used for signing tokens" # Enter shared secret
7474

7575
[smtp]
7676
host = "localhost"
@@ -195,8 +195,8 @@ In addition to updating the first `url` setting, `license-key`, and
195195
[database]
196196
# Where is your database?
197197
# NOTE: This version of Enterprise Web currently only supports Postgres >= 9.3 or SQLite3
198-
url = "postgres://postgres:password@localhost:5432/enterprise" # ENV: DATABASE_URL
199-
# url = "sqlite3:///var/lib/influx-enterprise/enterprise.db"
198+
url = "postgres://postgres:password@localhost:5432/enterprise" # ENV: DATABASE_URL
199+
# url = "sqlite3:///var/lib/influx-enterprise/enterprise.db"
200200
>
201201
If you’re using a non-SSL version of Postgres, add the `?sslmode=disable`
202202
option to the first `url` setting in the `[database]` section:

content/enterprise_influxdb/v1.1/administration/upgrading.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -211,14 +211,14 @@ In each meta node’s configuration file (`/etc/influxdb/influxdb-meta.conf`), s
211211
* `registration-enabled` to `true`
212212
* `registration-server-url` to the hostname of the InfluxEnterprise Web Console
213213

214-
```
214+
```toml
215215
reporting-disabled = false
216216
bind-address = ""
217217
hostname = "enterprise-meta-01"
218218

219219
[enterprise]
220-
registration-enabled = true #
221-
registration-server-url = "http://<web_console_hostname>:3000" #
220+
registration-enabled = true # Set to 'true'
221+
registration-server-url = "http://<web_console_hostname>:3000" # Enter web console hostname
222222

223223
[...]
224224
```

content/enterprise_influxdb/v1.1/guides/migration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,23 +128,23 @@ Entering the IP or hostname alone will lead to errors.
128128
* `license-key` in the `[enterprise]` section to the license key you received on InfluxPortal **OR** `license-path` in the `[enterprise]` section to the local path to the JSON license file you received from InfluxData. The `license-key` and `license-path` settings are mutually exclusive and one must remain set to the empty string.
129129

130130

131-
```
131+
```toml
132132
# Hostname advertised by this host for remote addresses. This must be resolvable by all
133133
# other nodes in the cluster
134-
hostname="<enterprise-meta-0x>" #✨
134+
hostname="<enterprise-meta-0x>"
135135

136136
[enterprise]
137137
# Must be set to true to use the Enterprise Web UI
138-
registration-enabled = true #✨
138+
registration-enabled = true
139139

140140
# Must include the protocol (http://)
141-
registration-server-url = "http://<web-console-server-IP>:3000" #✨
141+
registration-server-url = "http://<web-console-server-IP>:3000"
142142

143143
# license-key and license-path are mutually exclusive, use only one and leave the other blank
144-
license-key = "<your_license_key>" #✨ mutually exclusive with license-path
144+
license-key = "<your_license_key>" # Mutually exclusive with license-path
145145

146146
# license-key and license-path are mutually exclusive, use only one and leave the other blank
147-
license-path = "/path/to/readable/JSON.license.file" #✨ mutually exclusive with license-key
147+
license-path = "/path/to/readable/JSON.license.file" # Mutually exclusive with license-key
148148
```
149149

150150
### 6. Start the data node

content/enterprise_influxdb/v1.1/production_installation/data_node_installation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -118,44 +118,44 @@ Second, in `/etc/influxdb/influxdb.conf`, set:
118118

119119
`license-key` in the `[enterprise]` section to the license key you received on InfluxPortal **OR** `license-path` in the `[enterprise]` section to the local path to the JSON license file you received from InfluxData. The `license-key` and `license-path` settings are mutually exclusive and one must remain set to the empty string.
120120

121-
```
121+
```toml
122122
# Change this option to true to disable reporting.
123123
# reporting-disabled = false
124124
# bind-address = ":8088"
125-
hostname="<enterprise-data-0x>" #✨
125+
hostname="<enterprise-data-0x>"
126126

127127
[enterprise]
128128
registration-enabled = false
129129

130130
registration-server-url = ""
131131

132132
# license-key and license-path are mutually exclusive, use only one and leave the other blank
133-
license-key = "<your_license_key>" #✨ mutually exclusive with license-path
133+
license-key = "<your_license_key>" # Mutually exclusive with license-path
134134

135135
# The path to a valid license file. license-key and license-path are mutually exclusive,
136136
# use only one and leave the other blank.
137-
license-path = "/path/to/readable/JSON.license.file" #✨ mutually exclusive with license-key
137+
license-path = "/path/to/readable/JSON.license.file" # Mutually exclusive with license-key
138138

139139
[meta]
140140
# Where the cluster metadata is stored
141141
dir = "/var/lib/influxdb/meta" # data nodes do require a local meta directory
142142

143143
[...]
144144

145-
[http] #✨
145+
[http]
146146
# Determines whether HTTP endpoint is enabled.
147147
# enabled = true
148148

149149
# The bind address used by the HTTP service.
150150
# bind-address = ":8086"
151151

152152
# Determines whether HTTP authentication is enabled.
153-
auth-enabled = true #✨ this is recommended but not required
153+
auth-enabled = true # Recommended, but not required
154154

155155
[...]
156156

157157
# The JWT auth shared secret to validate requests using JSON web tokens.
158-
shared-secret = "long pass phrase used for signing tokens" #✨
158+
shared-secret = "long pass phrase used for signing tokens"
159159
```
160160

161161
### 3. Start the Data Service

content/enterprise_influxdb/v1.1/production_installation/meta_node_installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,23 +117,23 @@ Entering the IP or hostname alone will lead to errors.
117117
* `license-key` in the `[enterprise]` section to the license key you received on InfluxPortal **OR** `license-path` in the `[enterprise]` section to the local path to the JSON license file you received from InfluxData. The `license-key` and `license-path` settings are mutually exclusive and one must remain set to the empty string.
118118

119119

120-
```
120+
```toml
121121
# Hostname advertised by this host for remote addresses. This must be resolvable by all
122122
# other nodes in the cluster
123-
hostname="<enterprise-meta-0x>" #✨
123+
hostname="<enterprise-meta-0x>"
124124

125125
[enterprise]
126126
# Must be set to true to use the Enterprise Web UI
127-
registration-enabled = true #✨
127+
registration-enabled = true
128128

129129
# Must include the protocol (http://)
130-
registration-server-url = "http://<web-console-server-IP>:3000" #✨
130+
registration-server-url = "http://<web-console-server-IP>:3000"
131131

132132
# license-key and license-path are mutually exclusive, use only one and leave the other blank
133-
license-key = "<your_license_key>" #✨ mutually exclusive with license-path
133+
license-key = "<your_license_key>" # Mutually exclusive with license-path
134134

135135
# license-key and license-path are mutually exclusive, use only one and leave the other blank
136-
license-path = "/path/to/readable/JSON.license.file" #✨ mutually exclusive with license-key
136+
license-path = "/path/to/readable/JSON.license.file" # Mutually exclusive with license-key
137137
```
138138

139139
### III. Start the Meta Service

content/enterprise_influxdb/v1.1/production_installation/web_console_installation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,17 @@ In `/etc/influx-enterprise/influx-enterprise.conf`, set:
6161
6262
* `shared-secret` in the `[influxdb]` section to the same pass phrase that you used in your data node configuration files
6363

64-
```
65-
url = "http://<your_server's_IP_address>:3000" #✨
64+
```toml
65+
url = "http://<your_server's_IP_address>:3000"
6666

6767
hostname = "localhost"
6868
port = "3000"
6969

70-
license-key = "<your_license_key>" #✨ mutually exclusive with license-file
71-
license-file = "/path/to/readable/JSON.license.file" #✨ mutually exclusive with license-key
70+
license-key = "<your_license_key>" # Mutually exclusive with license-file
71+
license-file = "/path/to/readable/JSON.license.file" # Mutually exclusive with license-key
7272

7373
[influxdb]
74-
shared-secret = "long pass phrase used for signing tokens" #✨
74+
shared-secret = "long pass phrase used for signing tokens"
7575

7676
[smtp]
7777
host = "localhost"
@@ -197,8 +197,8 @@ In addition to updating the first `url` setting, `license-key`, and
197197
[database]
198198
# Where is your database?
199199
# NOTE: This version of Enterprise Web currently only supports Postgres >= 9.3 or SQLite3
200-
url = "postgres://postgres:password@localhost:5432/enterprise" # ENV: DATABASE_URL
201-
# url = "sqlite3:///var/lib/influx-enterprise/enterprise.db"
200+
url = "postgres://postgres:password@localhost:5432/enterprise" # ENV: DATABASE_URL
201+
# url = "sqlite3:///var/lib/influx-enterprise/enterprise.db"
202202
>
203203
If you’re using a non-SSL version of Postgres, add the `?sslmode=disable`
204204
option to the first `url` setting in the `[database]` section:

0 commit comments

Comments
 (0)