diff --git a/docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md b/docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md old mode 100644 new mode 100755 index 9d276340..f54735a6 --- a/docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md +++ b/docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md @@ -21,49 +21,59 @@ To see which values you can set and which values they are allowed to have take a `hypernode-systemctl settings --help` -- `blackfire_enabled`: a great tool to find performance bottlenecks in Magento -- `blackfire_server_token` -- `blackfire_server_id` -- `composer_version`: Change the Composer version -- `disable_optimizer_switch` -- `elasticsearch_enabled`: Enable Elasticsearch -- `elasticsearch_version`: Change the Elasticsearch version -- `enable_ioncube`: Only enable this if you really have to, as Ioncube is a performance killer -- `firewall_block_ftp_enabled`: indicates whether FTP (which is unsafe) is completely blocked or not -- `magerun2_version`: Change the N98 Magerun version -- `mailhog_enabled`: Enable the Mailhog feature -- `managed_vhosts_enabled`: Enable the managed_vhosts nginx configuration -- `modern_ssh_config_enabled` -- `modern_ssl_config_enabled`: Safer SSL and SSH configuration: you can configure Mozilla Modern SSL and enable stricter SSH encryption -- `mysql_version`: Change the MySQL version (note: once set to 5.7 this can't be reverted) -- `mysql_disable_stopwords` -- `mysql_tmp_on_data_enabled` -- `mysql_ft_min_word_len` -- `mysql_enable_large_thread_stack` -- `nodejs_version`: Change the Node version -- `openvpn_enabled`: Enables [OpenVPN](https://community.hypernode.io/#/Documentation/hypernode-vpn/README?) for secure database connections -- `opensearch_enabled`: Enable OpenSearch -- `opensearch_version`: Change the OpenSearch version -- `override_sendmail_return_path`: Override the return-path (Due to the bug in Magento 2) -- `password_auth`: indicates whether password authentication for the Hypernode is allowed instead of only SSH keys. -- `permissive_memory_management`: Configure [memory management policy](https://changelog.hypernode.com/release-5946-configurable-memory-management-policy-and-rss-bruteforce-detection/) (OOM kills) -- `php_version`: Change the PHP version -- `php_apcu_enabled`: Enable the php-apcu module -- `php_amqp_enabled`: Enable the php-amqp module -- `php_xdebug_enabled`: Enable Xdebug for [remote debugging](../php/remote-debugging.md) -- `php_xdebug_cloud_key`: Set the Xdebug cloud key for [remote debugging](../php/remote-debugging.md) -- `redis_persistent_instance` -- `redis_version`: Change the Redis version -- `rabbitmq_enabled`: a popular open source message broker -- `supervisor_enabled` -- `tideways_enabled`: Enable [Tideways](https://tideways.com) -- `tideways_api_key`: The API key for your application -- `tideways_sample_rate`: Configure the amount of tracing data collected with the [sampling rate](https://support.tideways.com/documentation/setup/configuration/sampling.html) configuration. -- `unixodbc_enabled` -- `varnish_enabled`: Enable Varnish -- `varnish_version`: Change the Varnish version -- `varnish_secret` -- `varnish_esi_ignore_https` +| Field | Default Value | Possible Values | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| **blackfire_enabled**
A great tool to find performance bottlenecks
in Magento
| False | True, False | +| **composer_version**
Change the Composer version | 2.x | 1.x, 2.2, 2.6, 2.7, 2.x | +| **datadog_enabled**
Enable Datadog | False | True, False | +| **disable_optimizer_switch**
Disable the optimizer switch | False | True, False | +| **elasticsearch_enabled**
Enable Elasticsearch | False | True, False | +| **elasticsearch_version**
Change the Elasticsearch version | 7.x | 5.2, 6.x, 7.x | +| **enable_ioncube**
Only enable this if you really have to,
as Ioncube is a performance killer
| False | True, False | +| **firewall_block_ftp_enabled**
Indicates whether FTP (which is unsafe) is completely blocked or not | False | True, False | +| **magerun2_version**
Change the N98 Magerun version | latest | 3.x, 4.x, 5.x, 6.x, 7.x, latest | +| **mailhog_enabled**
Enable the Mailhog feature | False | True, False | +| **managed_vhosts_enabled**
Enable the managed_vhosts nginx configuration | True | True, False | +| **modern_ssh_config_enabled**
Enable modern SSH configuration | False | True, False | +| **modern_ssl_config_enabled**
Safer SSL and SSH configuration:
you can configure Mozilla Modern SSL and enable
stricter SSH encryption
| False | True, False | +| **mysql_disable_stopwords**
Disable MySQL stopwords | False | True, False | +| **mysql_enable_explicit_defaults_for_timestamp**
| False | True, False | +| **mysql_enable_large_thread_stack**
Enable large thread stacks in MySQL | False | True, False | +| **mysql_ft_min_word_len**
Set minimum word length for MySQL full-text searches | 4 | 4, 2 | +| **mysql_long_query_time**
| 2 | 2, 5, 10, 15, 30 | +| **mysql_tmp_on_data_enabled**
Enable temporary data directory on MySQL | False | True, False | +| **mysql_version**
Change the MySQL version (note: once set to 5.7 this can't be
reverted)
| 8.0 | 5.6, 5.7, 8.0 | +| **new_relic_browser_monitoring_auto_instrument_enabled**
| True | True, False | +| **new_relic_distributed_tracing_enabled**
| True | True, False | +| **new_relic_enabled**
| False | True, False | +| **nodejs_version**
Change the Node version | 20 | 6, 10, 16, 18, 20 | +| **opensearch_auto_create_index**
| True | True, False | +| **opensearch_enabled**
Enable OpenSearch | True | True, False | +| **opensearch_version**
Change the OpenSearch version | 2.12 | 1.x, 2.6, 2.12 | +| **openvpn_enabled**
Enables OpenVPN for secure database connections | False | True, False | +| **password_auth**
Indicates whether password authentication for the Hypernode is
allowed instead of only SSH keys
| True | True, False | +| **permissive_memory_management**
Configure memory management policy (OOM kills) | False | True, False | +| **php_amqp_enabled**
Enable the php-amqp module | False | True, False | +| **php_apcu_enabled**
Enable the php-apcu module | True | True, False | +| **php_legacy_serialize_precision_enabled**
| True | True, False | +| **php_version**
Change the PHP version | 8.3 | 5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, 8.1, 8.2, 8.3, 8.4 | +| **php_xdebug_enabled**
Enable Xdebug for remote debugging | False | True, False | +| **rabbitmq_delayed_message_exchange_enabled**
| False | True, False | +| **rabbitmq_enabled**
A popular open source message broker | False | True, False | +| **redis_eviction_policy**
| volatile-lru | noeviction
allkeys-lru
allkeys-lfu
volatile-lru
volatile-lfu
allkeys-random
volatile-random
volatile-ttl | +| **redis_persistent_eviction_policy**
| allkeys-lru | noeviction
allkeys-lru
allkeys-lfu
volatile-lru
volatile-lfu
allkeys-random
volatile-random
volatile-ttl | +| **redis_persistent_instance**
Enable Redis persistent instance | False | True, False | +| **redis_version**
Change the Redis version | 7.x | 5.0, 6.x, 7.x | +| **supervisor_enabled**
Enable Supervisor | False | True, False | +| **support_insecure_legacy_tls**
| False | True, False | +| **tideways_enabled**
Enable Tideways | False | True, False | +| **unixodbc_enabled**
Enable UnixODBC | False | True, False | +| **varnish_enabled**
Enable Varnish | False | True, False | +| **varnish_esi_ignore_https**
Ignore HTTPS for Varnish ESI | True | True, False | +| **varnish_http_resp_hdr_len**
| None | 4k, 8k, 16k, 32k, 64k, 128k, 256k | +| **varnish_http_resp_size**
| None | 4k, 8k, 16k, 32k, 64k, 128k, 256k | +| **varnish_large_thread_pool_stack**
| False | True, False | +| **varnish_version**
Change the Varnish version | 7.x | 4.0, 6.0, 7.x | ### Checking a Value for a Setting @@ -75,7 +85,7 @@ To see which value a setting has you can run the following: To set a setting to a certain value you can run the following: -`hypernode-systemctl settings php_version 7.1` +`hypernode-systemctl settings php_version 8.3` If an invalid value is provided you will be notified of this during the setting procedure.