search

mul53 / activestorage-ipfs

This gem extends the ActiveStorage::Service with an implementation for IPFS
MIT License
19 stars 5 forks source link

readme

Activestorage::Ipfs

This gem extends the ActiveStorage::Service with an implementation for IPFS

Installation

Add this line to your application's Gemfile:

gem 'activestorage-ipfs'

And then execute:

$ bundle install

Usage

In your Rails 5.2+ app, run:

rails active_storage:install

This will copy over active_storage migration for creating the tables and then run:

rails db:migrate

We now need to tell activestorage to use the ipfs service. Declare a Ipfs service in config/storage.yml. Each service requires a api_endpoint and a gateway_endpoint

ipfs:
  service: Ipfs
  api_endpoint: http://localhost:5001
  gateway_endpoint: http://localhost:8080

Direct Upload

Direct uploads can be used by installing activestorage-ipfs-js run:

yarn install activestorage-ipfs-js

After installing the js package replace this line in app/javascript/packs/application.js

require("@rails/activestorage").start()

With this line:

require("activestorage-ipfs-js").start()

We annotate the file inputs with the direct upload url, and the ipfs api url

<%= form.file_field :file, direct_upload: true, data: { ipfs_url: 'http://localhost:5001' }  =%>

If Ipfs is running at localhost run the following cmds:

ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["*"]'
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST"]

That's it! Upon submission the file upload begins

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mul53/activestorage-ipfs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Activestorage::Ipfs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.