Skip to content
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

Jump to bottom

docs: remove refs to environment in samples, update description #134

Merged
merged 1 commit into from Feb 21, 2023
Merged

docs: remove refs to environment in samples, update description #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 1 addition & 5 deletions README.md
View file
Open in desktop
Expand Up @@ -86,7 +86,7 @@ Argument | Description | Required? | Type | Default Value|
`url` | Unleash server URL. | Y | String | N/A |
`app_name` | Name of your program. | Y | String | N/A |
`instance_id` | Identifier for the running instance of program. Important so you can trace back to where metrics are being collected from. **Highly recommended be be set.** | N | String | random UUID |
`environment` | Environment the program is running on. Could be for example `prod` or `dev`. Not yet in use. | N | String | `default` |
`environment` | Unleash context option. Could be for example `prod` or `dev`. Not yet in use. **Not** the same as the SDK's [Unleash environment](https://docs.getunleash.io/reference/environments). | N | String | `default` |
`project_name` | Name of the project to retrieve features from. If not set, all feature flags will be retrieved. | N | String | nil |
`refresh_interval` | How often the unleash client should check with the server for configuration changes. | N | Integer | 15 |
`metrics_interval` | How often the unleash client should send metrics to server. | N | Integer | 60 |
Expand Down Expand Up @@ -145,7 +145,6 @@ Unleash.configure do |config|
config.url = 'https://unleash.herokuapp.com/api'
# config.instance_id = "#{Socket.gethostname}"
config.logger = Rails.logger
config.environment = Rails.env
end

UNLEASH = Unleash::Client.new
Expand Down Expand Up @@ -180,7 +179,6 @@ Then you may keep the client configuration still in `config/initializers/unleash
```ruby
Unleash.configure do |config|
config.app_name = Rails.application.class.parent.to_s
config.environment = Rails.env
config.url = 'https://unleash.herokuapp.com/api'
config.custom_http_headers = {'Authorization': '<API token>'}
end
Expand Down Expand Up @@ -228,7 +226,6 @@ on_worker_boot do

::UNLEASH = Unleash::Client.new(
app_name: 'my_rails_app',
environment: 'development',
url: 'https://unleash.herokuapp.com/api',
custom_http_headers: {'Authorization': '<API token>'},
)
Expand All @@ -254,7 +251,6 @@ PhusionPassenger.on_event(:starting_worker_process) do |forked|
config.app_name = Rails.application.class.parent.to_s
# config.instance_id = "#{Socket.gethostname}"
config.logger = Rails.logger
config.environment = Rails.env
config.url = 'https://unleash.herokuapp.com/api'
config.custom_http_headers = {'Authorization': '<API token>'}
end
Expand Down