diff --git a/docs/deploying_clearml/clearml_server_config.md b/docs/deploying_clearml/clearml_server_config.md index 71f0aef8..c7799c10 100644 --- a/docs/deploying_clearml/clearml_server_config.md +++ b/docs/deploying_clearml/clearml_server_config.md @@ -72,8 +72,10 @@ The ClearML Server uses the following configuration files: * `services.conf` When starting up, the ClearML Server will look for these configuration files, in the `/opt/clearml/config` directory -(this path can be modified using the `CLEARML_CONFIG_DIR` environment variable). -The default configuration files are in the [clearml-server](https://github.com/allegroai/clearml-server/tree/master/apiserver/config/default) repository. +(this path can be modified using the `CLEARML_CONFIG_DIR` environment variable). The default configuration files are in the [clearml-server](https://github.com/allegroai/clearml-server/tree/master/apiserver/config/default) repository. + +If you want to modify server configuration, and the relevant configuration file doesn't exist, you can create the file, +and input the relevant modified configuration. :::note Within the default structure, the `services.conf` file is represented by a subdirectory with service-specific `.conf` files. @@ -134,6 +136,11 @@ For example, given the default `secure.conf` file contents: } ``` +:::tip +If the `secure.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or +an alternate folder you configured), and input the modified configuration +::: + the default secret for the system's apiserver component can be overridden by setting the following environment variable: `CLEARML__SECURE__CREDENTIALS__APISERVER__USER_SECRET="my-new-secret"` @@ -164,6 +171,11 @@ The following example, which is based on AWS load balancing, demonstrates the co } } + :::tip + If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or + an alternate folder you configured), and input the modified configuration + ::: + 1. Use the following load balancer configuration: * Listeners: @@ -266,6 +278,11 @@ Without web login authentication, ClearML Server does not restrict access (by de } } + :::tip + If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or + an alternate folder you configured), and input the modified configuration + ::: + 1. Restart ClearML Server. ### Using Hashed Passwords @@ -277,22 +294,28 @@ You can also use hashed passwords instead of plain-text passwords. To do that: b'JDJiJDEyJDk3OHBFcHFlNEsxTkFoZDlPcGZsbC5sU1pmM3huZ1RpeHc0ay5WUjlzTzN5WE1WRXJrUmhp' ``` - Use the command's output as the user's password. Resulting `apiserver.conf` file should look as follows: - - auth { - # Fixed users login credentials - # No other user will be able to login - fixed_users { - enabled: true - pass_hashed: true - users: [ - { - username: "jane" - password: "JDJiJDEyJDk3OHBFcHFlNEsxTkFoZDlPcGZsbC5sU1pmM3huZ1RpeHc0ay5WUjlzTzN5WE1WRXJrUmhp" - name: "Jane Doe" - } - ] - } + ``` + auth { + # Fixed users login credentials + # No other user will be able to login + fixed_users { + enabled: true + pass_hashed: true + users: [ + { + username: "jane" + password: "JDJiJDEyJDk3OHBFcHFlNEsxTkFoZDlPcGZsbC5sU1pmM3huZ1RpeHc0ay5WUjlzTzN5WE1WRXJrUmhp" + name: "Jane Doe" + } + ] } + } + ``` + + :::tip + If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or + an alternate folder you configured), and input the modified configuration + ::: ### Non-responsive Task Watchdog @@ -323,6 +346,11 @@ Modify the following settings for the watchdog: watch_interval_sec: 900 } } + + :::tip + If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or + an alternate folder you configured), and input the modified configuration + ::: 1. Restart ClearML Server. @@ -340,6 +368,11 @@ cors { } ``` +:::tip +If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or +an alternate folder you configured), and input the modified configuration +::: + See the [Flask-Cors documentation](https://flask-cors.corydolphin.com/en/latest/api.html) for detailed initialization options. @@ -382,6 +415,11 @@ organization.ui_actions: { } ``` +:::tip +If the `services.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or +an alternate folder you configured), and input the modified configuration +::: + The action will appear in the context menu for the object type in which it was specified: * Task, model, dataview - Right-click an object in the [experiments](../webapp/webapp_exp_table.md), [models](../webapp/webapp_model_table.md), and [dataviews](../hyperdatasets/webapp/webapp_dataviews.md) tables respectively. Alternatively, click the object to