Merge pull request #2202 from Infisical/daniel/tls-docs

docs(sdks): Custom TLS certificate support
This commit is contained in:
Maidul Islam
2024-07-30 20:52:52 -04:00
committed by GitHub
4 changed files with 17 additions and 7 deletions
+4
View File
@@ -118,6 +118,10 @@ namespace Example
Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`) Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`)
</ParamField> </ParamField>
<ParamField query="SslCertificatePath" optional>
Optionally provide a path to a custom SSL certificate file. This can be substituted by setting the `INFISICAL_SSL_CERTIFICATE` environment variable to the contents of the certificate.
</ParamField>
<ParamField query="Auth" type="AuthenticationOptions"> <ParamField query="Auth" type="AuthenticationOptions">
The authentication object to use for the client. This is required unless you're using environment variables. The authentication object to use for the client. This is required unless you're using environment variables.
</ParamField> </ParamField>
+4
View File
@@ -122,6 +122,10 @@ public class App {
Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`) Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`)
</ParamField> </ParamField>
<ParamField query="setSSLCertificatePath()">
Optionally provide a path to a custom SSL certificate file. This can be substituted by setting the `INFISICAL_SSL_CERTIFICATE` environment variable to the contents of the certificate.
</ParamField>
<ParamField query="setAuth()" type="AuthenticationOptions"> <ParamField query="setAuth()" type="AuthenticationOptions">
The authentication object to use for the client. This is required unless you're using environment variables. The authentication object to use for the client. This is required unless you're using environment variables.
</ParamField> </ParamField>
+4
View File
@@ -137,6 +137,10 @@ Import the SDK and create a client instance with your [Machine Identity](/docume
The level of logs you wish to log The logs are derived from Rust, as we have written our base SDK in Rust. The level of logs you wish to log The logs are derived from Rust, as we have written our base SDK in Rust.
</ParamField> </ParamField>
<ParamField query="sslCertificatePath" optional>
Optionally provide a path to a custom SSL certificate file. This can be substituted by setting the `INFISICAL_SSL_CERTIFICATE` environment variable to the contents of the certificate.
</ParamField>
<ParamField query="auth" type="AuthenticationOptions"> <ParamField query="auth" type="AuthenticationOptions">
The authentication object to use for the client. This is required unless you're using environment variables. The authentication object to use for the client. This is required unless you're using environment variables.
</ParamField> </ParamField>
+5 -7
View File
@@ -97,16 +97,14 @@ client = InfisicalClient(ClientSettings(
If manually set to 0, caching will be disabled, this is not recommended. If manually set to 0, caching will be disabled, this is not recommended.
</ParamField> </ParamField>
<ParamField query="site_url" type="string" default="https://app.infisical.com" optional>
<ParamField
query="site_url"
type="string"
default="https://app.infisical.com"
optional
>
Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`) Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`)
</ParamField> </ParamField>
<ParamField query="ssl_certificate_path" optional>
Optionally provide a path to a custom SSL certificate file. This can be substituted by setting the `INFISICAL_SSL_CERTIFICATE` environment variable to the contents of the certificate.
</ParamField>
<ParamField query="auth" type="AuthenticationOptions"> <ParamField query="auth" type="AuthenticationOptions">
The authentication object to use for the client. This is required unless you're using environment variables. The authentication object to use for the client. This is required unless you're using environment variables.
</ParamField> </ParamField>