Skip to content

Commit 710e141

Browse files
ddelwigddelwig
authored
Merge pull request #313 from ByteInternet/feature/add_fields_for_hypernode_systemctl_settings
Update fields for hypernode-systemctl settings
2 parents e29a414 + 04d67a9 commit 710e141

File tree

1 file changed

+54
-44
lines changed

1 file changed

+54
-44
lines changed

‎docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md‎

100644100755
Lines changed: 54 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -21,49 +21,59 @@ To see which values you can set and which values they are allowed to have take a
2121

2222
`hypernode-systemctl settings --help`
2323

24-
- `blackfire_enabled`: a great tool to find performance bottlenecks in Magento
25-
- `blackfire_server_token`
26-
- `blackfire_server_id`
27-
- `composer_version`: Change the Composer version
28-
- `disable_optimizer_switch`
29-
- `elasticsearch_enabled`: Enable Elasticsearch
30-
- `elasticsearch_version`: Change the Elasticsearch version
31-
- `enable_ioncube`: Only enable this if you really have to, as Ioncube is a performance killer
32-
- `firewall_block_ftp_enabled`: indicates whether FTP (which is unsafe) is completely blocked or not
33-
- `magerun2_version`: Change the N98 Magerun version
34-
- `mailhog_enabled`: Enable the Mailhog feature
35-
- `managed_vhosts_enabled`: Enable the managed_vhosts nginx configuration
36-
- `modern_ssh_config_enabled`
37-
- `modern_ssl_config_enabled`: Safer SSL and SSH configuration: you can configure Mozilla Modern SSL and enable stricter SSH encryption
38-
- `mysql_version`: Change the MySQL version (note: once set to 5.7 this can't be reverted)
39-
- `mysql_disable_stopwords`
40-
- `mysql_tmp_on_data_enabled`
41-
- `mysql_ft_min_word_len`
42-
- `mysql_enable_large_thread_stack`
43-
- `nodejs_version`: Change the Node version
44-
- `openvpn_enabled`: Enables [OpenVPN](https://community.hypernode.io/#/Documentation/hypernode-vpn/README?) for secure database connections
45-
- `opensearch_enabled`: Enable OpenSearch
46-
- `opensearch_version`: Change the OpenSearch version
47-
- `override_sendmail_return_path`: Override the return-path (Due to the bug in Magento 2)
48-
- `password_auth`: indicates whether password authentication for the Hypernode is allowed instead of only SSH keys.
49-
- `permissive_memory_management`: Configure [memory management policy](https://changelog.hypernode.com/release-5946-configurable-memory-management-policy-and-rss-bruteforce-detection/) (OOM kills)
50-
- `php_version`: Change the PHP version
51-
- `php_apcu_enabled`: Enable the php-apcu module
52-
- `php_amqp_enabled`: Enable the php-amqp module
53-
- `php_xdebug_enabled`: Enable Xdebug for [remote debugging](../php/remote-debugging.md)
54-
- `php_xdebug_cloud_key`: Set the Xdebug cloud key for [remote debugging](../php/remote-debugging.md)
55-
- `redis_persistent_instance`
56-
- `redis_version`: Change the Redis version
57-
- `rabbitmq_enabled`: a popular open source message broker
58-
- `supervisor_enabled`
59-
- `tideways_enabled`: Enable [Tideways](https://tideways.com)
60-
- `tideways_api_key`: The API key for your application
61-
- `tideways_sample_rate`: Configure the amount of tracing data collected with the [sampling rate](https://support.tideways.com/documentation/setup/configuration/sampling.html) configuration.
62-
- `unixodbc_enabled`
63-
- `varnish_enabled`: Enable Varnish
64-
- `varnish_version`: Change the Varnish version
65-
- `varnish_secret`
66-
- `varnish_esi_ignore_https`
24+
| Field | Default Value | Possible Values |
25+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
26+
| **blackfire_enabled**<br/><sub>A great tool to find performance bottlenecks<br />in Magento</sub> | False | True, False |
27+
| **composer_version**<br/><sub>Change the Composer version</sub> | 2.x | 1.x, 2.2, 2.6, 2.7, 2.x |
28+
| **datadog_enabled**<br/><sub>Enable Datadog</sub> | False | True, False |
29+
| **disable_optimizer_switch**<br/><sub>Disable the optimizer switch</sub> | False | True, False |
30+
| **elasticsearch_enabled**<br/><sub>Enable Elasticsearch</sub> | False | True, False |
31+
| **elasticsearch_version**<br/><sub>Change the Elasticsearch version</sub> | 7.x | 5.2, 6.x, 7.x |
32+
| **enable_ioncube**<br/><sub>Only enable this if you really have to,<br />as Ioncube is a performance killer</sub> | False | True, False |
33+
| **firewall_block_ftp_enabled**<br/><sub>Indicates whether FTP (which is unsafe) is completely blocked or not</sub> | False | True, False |
34+
| **magerun2_version**<br/><sub>Change the N98 Magerun version</sub> | latest | 3.x, 4.x, 5.x, 6.x, 7.x, latest |
35+
| **mailhog_enabled**<br/><sub>Enable the Mailhog feature</sub> | False | True, False |
36+
| **managed_vhosts_enabled**<br/><sub>Enable the managed_vhosts nginx configuration</sub> | True | True, False |
37+
| **modern_ssh_config_enabled**<br/><sub>Enable modern SSH configuration</sub> | False | True, False |
38+
| **modern_ssl_config_enabled**<br/><sub>Safer SSL and SSH configuration:<br />you can configure Mozilla Modern SSL and enable<br />stricter SSH encryption</sub> | False | True, False |
39+
| **mysql_disable_stopwords**<br/><sub>Disable MySQL stopwords</sub> | False | True, False |
40+
| **mysql_enable_explicit_defaults_for_timestamp**<br/><sub></sub> | False | True, False |
41+
| **mysql_enable_large_thread_stack**<br/><sub>Enable large thread stacks in MySQL</sub> | False | True, False |
42+
| **mysql_ft_min_word_len**<br/><sub>Set minimum word length for MySQL full-text searches</sub> | 4 | 4, 2 |
43+
| **mysql_long_query_time**<br/><sub></sub> | 2 | 2, 5, 10, 15, 30 |
44+
| **mysql_tmp_on_data_enabled**<br/><sub>Enable temporary data directory on MySQL</sub> | False | True, False |
45+
| **mysql_version**<br/><sub>Change the MySQL version (note: once set to 5.7 this can't be<br />reverted)</sub> | 8.0 | 5.6, 5.7, 8.0 |
46+
| **new_relic_browser_monitoring_auto_instrument_enabled**<br/><sub></sub> | True | True, False |
47+
| **new_relic_distributed_tracing_enabled**<br/><sub></sub> | True | True, False |
48+
| **new_relic_enabled**<br/><sub></sub> | False | True, False |
49+
| **nodejs_version**<br/><sub>Change the Node version</sub> | 20 | 6, 10, 16, 18, 20 |
50+
| **opensearch_auto_create_index**<br/><sub></sub> | True | True, False |
51+
| **opensearch_enabled**<br/><sub>Enable OpenSearch</sub> | True | True, False |
52+
| **opensearch_version**<br/><sub>Change the OpenSearch version</sub> | 2.12 | 1.x, 2.6, 2.12 |
53+
| **openvpn_enabled**<br/><sub>Enables OpenVPN for secure database connections</sub> | False | True, False |
54+
| **password_auth**<br/><sub>Indicates whether password authentication for the Hypernode is<br />allowed instead of only SSH keys</sub> | True | True, False |
55+
| **permissive_memory_management**<br/><sub>Configure memory management policy (OOM kills)</sub> | False | True, False |
56+
| **php_amqp_enabled**<br/><sub>Enable the php-amqp module</sub> | False | True, False |
57+
| **php_apcu_enabled**<br/><sub>Enable the php-apcu module</sub> | True | True, False |
58+
| **php_legacy_serialize_precision_enabled**<br/><sub></sub> | True | True, False |
59+
| **php_version**<br/><sub>Change the PHP version</sub> | 8.3 | 5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, 8.1, 8.2, 8.3, 8.4 |
60+
| **php_xdebug_enabled**<br/><sub>Enable Xdebug for remote debugging</sub> | False | True, False |
61+
| **rabbitmq_delayed_message_exchange_enabled**<br/><sub></sub> | False | True, False |
62+
| **rabbitmq_enabled**<br/><sub>A popular open source message broker</sub> | False | True, False |
63+
| **redis_eviction_policy**<br/><sub></sub> | volatile-lru | noeviction<br />allkeys-lru<br />allkeys-lfu<br />volatile-lru<br />volatile-lfu<br />allkeys-random<br />volatile-random<br />volatile-ttl |
64+
| **redis_persistent_eviction_policy**<br/><sub></sub> | allkeys-lru | noeviction<br />allkeys-lru<br />allkeys-lfu<br />volatile-lru<br />volatile-lfu<br />allkeys-random<br />volatile-random<br />volatile-ttl |
65+
| **redis_persistent_instance**<br/><sub>Enable Redis persistent instance</sub> | False | True, False |
66+
| **redis_version**<br/><sub>Change the Redis version</sub> | 7.x | 5.0, 6.x, 7.x |
67+
| **supervisor_enabled**<br/><sub>Enable Supervisor</sub> | False | True, False |
68+
| **support_insecure_legacy_tls**<br/><sub></sub> | False | True, False |
69+
| **tideways_enabled**<br/><sub>Enable Tideways</sub> | False | True, False |
70+
| **unixodbc_enabled**<br/><sub>Enable UnixODBC</sub> | False | True, False |
71+
| **varnish_enabled**<br/><sub>Enable Varnish</sub> | False | True, False |
72+
| **varnish_esi_ignore_https**<br/><sub>Ignore HTTPS for Varnish ESI</sub> | True | True, False |
73+
| **varnish_http_resp_hdr_len**<br/><sub></sub> | None | 4k, 8k, 16k, 32k, 64k, 128k, 256k |
74+
| **varnish_http_resp_size**<br/><sub></sub> | None | 4k, 8k, 16k, 32k, 64k, 128k, 256k |
75+
| **varnish_large_thread_pool_stack**<br/><sub></sub> | False | True, False |
76+
| **varnish_version**<br/><sub>Change the Varnish version</sub> | 7.x | 4.0, 6.0, 7.x |
6777

6878
### Checking a Value for a Setting
6979

@@ -75,7 +85,7 @@ To see which value a setting has you can run the following:
7585

7686
To set a setting to a certain value you can run the following:
7787

78-
`hypernode-systemctl settings php_version 7.1`
88+
`hypernode-systemctl settings php_version 8.3`
7989

8090
If an invalid value is provided you will be notified of this during the setting procedure.
8191

0 commit comments

Comments
 (0)