Skip to content

Commit 300d045

Browse files
committed
Update readme and initializer
1 parent ad5ca79 commit 300d045

File tree

2 files changed

+6
-28
lines changed

2 files changed

+6
-28
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Rails.application.configure do
118118
# Base controller used for Litestream dashboard
119119
config.litestream.base_controller_class = "MyApplicationController"
120120
# Set the location of the Litestream config
121-
config.config_path = "config/litestream.yml"
121+
config.litestream.config_path = "config/litestream.yml"
122122
end
123123
```
124124

lib/litestream/generators/litestream/templates/initializer.rb

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,9 @@
66

77
Rails.application.configure do
88
# Configure Litestream through environment variables. Use Rails encrypted credentials for secrets.
9-
#
109
# litestream_credentials = Rails.application.credentials.litestream
1110

12-
# Replica-specific bucket location.
13-
#
14-
# This will be your bucket's URL without the `https://` prefix.
11+
# Replica-specific bucket location. This will be your bucket's URL without the `https://` prefix.
1512
# For example, if you used DigitalOcean Spaces, your bucket URL could look like:
1613
#
1714
# https://myapp.fra1.digitaloceanspaces.com
@@ -22,46 +19,27 @@
2219
#
2320
# config.litestream.replica_bucket = litestream_credentials&.replica_bucket
2421
#
25-
#
26-
# Replica-specific authentication key
27-
#
28-
# Litestream needs authentication credentials to access your storage provider bucket.
29-
#
22+
# Replica-specific authentication key. Litestream needs authentication credentials to access your storage provider bucket.
3023
# config.litestream.replica_key_id = litestream_credentials&.replica_key_id
3124
#
32-
#
33-
# Replica-specific secret key
34-
#
35-
# Litestream needs authentication credentials to access your storage provider bucket.
36-
#
25+
# Replica-specific secret key. Litestream needs authentication credentials to access your storage provider bucket.
3726
# config.litestream.replica_access_key = litestream_credentials&.replica_access_key
3827
#
39-
#
40-
# Replica-specific region
41-
#
42-
# Optionally specifies the bucket’s region. Only used for AWS S3 & Backblaze B2.
43-
#
28+
# Replica-specific region. Set the bucket’s region. Only used for AWS S3 & Backblaze B2.
4429
# config.litestream.replica_region = "us-east-1"
4530
#
46-
#
47-
# Replica-specific endpoint
48-
#
49-
# Optionally specifies the endpoint URL of the S3-compatible service. Only required for non-AWS services.
50-
#
31+
# Replica-specific endpoint. Set the endpoint URL of the S3-compatible service. Only required for non-AWS services.
5132
# config.litestream.replica_endpoint = "endpoint.your-objectstorage.com"
5233

5334
# Configure the default Litestream config path
54-
#
5535
# config.config_path = Rails.root.join("config", "litestream.yml")
5636

5737
# Configure the Litestream dashboard
5838
#
5939
# Set the default base controller class
60-
#
6140
# config.litestream.base_controller_class = "MyApplicationController"
6241
#
6342
# Set authentication credentials for Litestream dashboard
64-
#
6543
# config.litestream.username = Rails.application.credentials.dig(:litestream, :username)
6644
# config.litestream.password = Rails.application.credentials.dig(:litestream, :password)
6745
end

0 commit comments

Comments
 (0)