litestream 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8ac42dbc299e313516510e87cfbfb30b8e2eb488e87aeaf3bbf38640986136
-  data.tar.gz: f004891377faa981fc43054ba75ed07cca4c8d42fd82644e23cc071a1eacbb1a
+  metadata.gz: e2240365f5c9159bef7b50e35fc6816aff14d1cbb726edd51306019456050e3d
+  data.tar.gz: 80c9e2d72ed8d9a08633a5b1a3084af8737006f223b206bdff86af076fa500bf
 SHA512:
-  metadata.gz: f7bc45ae7b85ea95bf18a64fab17a60647a7645536a7b63c06ba034c9da9cb3d39947f868b08f210c1f637bbbc5becefb7ce350c27fc4b73f7e6494dabecc98e
-  data.tar.gz: 3e8e2415fa628cd23aaf19c5881f79b4e288c232ec8ccc3cbafb16ed93bf6d1076969c429949735b77f49d48acbda38d141e3357f9dee147bb890b07c107a2cf
+  metadata.gz: 8dc6e9209a9f654037d7f214d2e825dfcc8e4a3c196f705cdb8701e0256db9e3d802ce42b02bd6b650cc76b70bae9c7127dd53ec90bc999c6f0cc95b3da590af
+  data.tar.gz: cb91236646f2850586cf540f7bf0278c28186e7c11ede6bd32e81fd4846a0a117290b9df8d683aa62832af9831482f8b3c68d4beec6f74bb9124fd67d5ed2eae

data/README.md

@@ -82,6 +82,37 @@ Again, however, you can take full manual control over the replication process an
 
 The full set of commands available to the `litestream` executable are covered in Litestream's [command reference](https://litestream.io/reference/). Currently, only the `replicate` command is provided as a rake task by the gem.
 
+### Using in development
+
+By default, installing the gem does not update your `Procfile.dev` file, and so Litestream will not be started in development. If you would like to test that your configuration is properly setup, you can manually add the `litestream:replicate` rake task to your `Procfile.dev` file. Just copy the `litestream` definition from the production `Procfile`. Then, in order to have a replication bucket for Litestream to point to, you can use a Docker instance of [MinIO](https://min.io/). MinIO is an S3-compatible object storage server that can be run locally. You can run a MinIO server with the following command:
+
+```sh
+docker run -p 9000:9000 -p 9001:9001 minio/minio server /data --console-address ":9001"
+```
+
+This gets us up and running quickly but it will only persist the data for as long as the Docker container is running, which is fine for local development testing.
+
+To simplify local development, you can add this command to your `Procfile.dev` file as well. This would allow you to start a MinIO server and a Litestream replication process in your local development environment with the single `bin/dev` command.
+
+Once you have a MinIO server running, you can create a bucket for Litestream to use. You can do this by visiting the MinIO console at [http://localhost:9001](http://localhost:9001) and logging in with the default credentials of `minioadmin` and `minioadmin`. Once logged in, you can create a bucket named `mybkt` by clicking the `+` button in the bottom right corner of the screen. You can then use the following configuration in your `config/initializers/litestream.rb` file:
+
+```ruby
+Litestream.configure do |config|
+  config.database_path = ActiveRecord::Base.connection_db_config.database
+  config.replica_url = "s3://mybkt.localhost:9000/"
+  config.replica_key_id = "minioadmin"
+  config.replica_access_key = "minioadmin"
+end
+```
+
+With Litestream properly configured and the MinIO server and Litestream replication process running, you should see something like the following in your terminal logs when you start the `bin/dev` process:
+
+```sh
+time=YYYY-MM-DDTHH:MM:SS level=INFO msg=litestream version=v0.3.xx
+time=YYYY-MM-DDTHH:MM:SS level=INFO msg="initialized db" path=/path/to/your/app/storage/development.sqlite3
+time=YYYY-MM-DDTHH:MM:SS level=INFO msg="replicating to" name=s3 type=s3 sync-interval=1s bucket=mybkt path="" region=us-east-1 endpoint=http://localhost:9000
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/litestream/commands.rb

@@ -73,12 +73,12 @@ module Litestream
     end
 
     def self.replicate
-      return if Litestream.configuration.nil?
-
-      ENV["LITESTREAM_DATABASE_PATH"] = Litestream.configuration.database_path
-      ENV["LITESTREAM_REPLICA_URL"] = Litestream.configuration.replica_url
-      ENV["LITESTREAM_ACCESS_KEY_ID"] = Litestream.configuration.replica_key_id
-      ENV["LITESTREAM_SECRET_ACCESS_KEY"] = Litestream.configuration.replica_access_key
+      if Litestream.configuration
+        ENV["LITESTREAM_DATABASE_PATH"] = Litestream.configuration.database_path
+        ENV["LITESTREAM_REPLICA_URL"] = Litestream.configuration.replica_url
+        ENV["LITESTREAM_ACCESS_KEY_ID"] = Litestream.configuration.replica_key_id
+        ENV["LITESTREAM_SECRET_ACCESS_KEY"] = Litestream.configuration.replica_access_key
+      end
 
       system(executable, "replicate", "--config", Rails.root.join("config", "litestream.yml").to_s)
     end

data/lib/litestream/generators/litestream/templates/litestream.rb

@@ -1,8 +1,38 @@
-litestream_credentials = Rails.application.credentials.litestream
+# Use this hook to configure the litestream-ruby gem.
+# All configuration options will be available as environment variables, e.g.
+# config.database_path becomes LITESTREAM_DATABASE_PATH
+# This allows you to configure Litestream using Rails encrypted credentials,
+# or some other mechanism where the values are only avaialble at runtime.
 
 Litestream.configure do |config|
-  config.database_path = ActiveRecord::Base.connection_db_config.database
-  config.replica_url = litestream_credentials.replica_url
-  config.replica_key_id = litestream_credentials.replica_key_id
-  config.replica_access_key = litestream_credentials.replica_access_key
+  # An example of using Rails encrypted credentials to configure Litestream.
+  # litestream_credentials = Rails.application.credentials.litestream
+  #
+  # The absolute or relative path to a SQLite database file.
+  # Litestream will monitor this file for changes and replicate them to the
+  # any of the configured replicas specified for this database in the
+  # `litestream.yml` configuration file.
+  # When using SQLite as your database engine for ActiveRecord, you should always
+  # set this to the path of your SQLite database file. You can do so using Rails'
+  # existing knowledge of the database path.
+  # config.database_path = ActiveRecord::Base.connection_db_config.database
+
+  # Short-hand form of specifying a replica location.
+  # When using S3, a value will look like "s3://mybkt.litestream.io/db"
+  # Litestream also supports Azure Blog Storage, Backblaze B2, DigitalOcean Spaces,
+  # Scaleway Object Storage, Google Cloud Storage, Linode Object Storage, and
+  # any SFTP server.
+  # In this example, we are using Rails encrypted credentials to store the URL to
+  # our storage provider bucket.
+  # config.replica_url = litestream_credentials.replica_url
+
+  # Replica-specific authentication key.
+  # Litestream needs authentication credentials to access your storage provider bucket.
+  # In this example, we are using Rails encrypted credentials to store the access key ID.
+  # config.replica_key_id = litestream_credentials.replica_key_id
+
+  # Replica-specific secret key.
+  # Litestream needs authentication credentials to access your storage provider bucket.
+  # In this example, we are using Rails encrypted credentials to store the secret access key.
+  # config.replica_access_key = litestream_credentials.replica_access_key
 end

data/lib/litestream/generators/litestream/templates/litestream.yml

@@ -1,3 +1,7 @@
+# This is the actual configuration file for litestream.
+# Edit this file as needed to configure your needs for litestream repication.
+#
+# For more details, see: https://litestream.io/reference/config/
 dbs:
   - path: $LITESTREAM_DATABASE_PATH
     replicas:

data/lib/litestream/version.rb

@@ -1,3 +1,3 @@
 module Litestream
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litestream
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2023-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Integrate Litestream with the RubyGems infrastructure.