Skip to content

README.md: Fix cacert documentation #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README.md: Fix cacert documentation #35

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8397a4a
README.md: Fix cacert documentation
bastelfreak Feb 20, 2023
f314fc1
Update README.md
bastelfreak Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ expected to be at `~/.puppetlabs/token` which is the default location used by
### initialization Settings

* `service-url` **[required]** - Base URL for the location of the Orchestrator API service
* `cacert` **[required]** - Path to the CA certificate file needed to verify the SSL connection to the API.
* `cacert` - Path to the CA certificate file needed to verify the SSL connection to the API.
* `token-file`- Path to a file with the RBAC token in it (defaults to `~/.puppetlabs/token`)
* `token` - Pass directly the RBAC token, if specified the token will be used instead of a token from file.
* `User-Agent`- Set `User-Agent` header for HTTP requests. Defaults to `OrchestratorRubyClient/[VERSION]`
Expand All @@ -37,11 +37,10 @@ expected to be at `~/.puppetlabs/token` which is the default location used by
require 'orchestrator_client'

# Create a new client
# Requires at least a server name and path to the CA certificate
# Requires at least a server name

client = OrchestratorClient.new({
'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1',
'cacert' => '/path/to/cert'
})

## Access endpoints through the client object
Expand Down