# active_storage-gridfs

**Repository Path**: mirrors_mongodb-labs/active_storage-gridfs

## Basic Information

- **Project Name**: active_storage-gridfs
- **Description**: This repository creates an 'active_storage-gridfs' gem, allowing users to connect GridFS with Rails Active Storage for file storage/management.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-16
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ActiveStorage::Gridfs

This gem is an adapter for MongoDB's GridFS use with ActiveStorage. It allows GridFS to be used similarly to AWS S3 or Google Cloud Storage Service for file storage and querying through ActiveStorage.

Active Storage has a hard dependency on ActiveRecord and thus is not compatible with Mongoid at this time. This gem only lets Active Storage use MongoDB as a file store, not as a data store.

## Usage

Set up Active Storage in your project using the instructions detailed [here](https://guides.rubyonrails.org/active_storage_overview.html). In [step 2](https://guides.rubyonrails.org/active_storage_overview.html#setup), add the following to your `config/storage.yml`:

```yml
gridfs:
  service: GridFS
  database: your_database_name
  uri: mongodb://localhost:27017 # or wherever your database is hosted
  bucket: fs  # optional, defaults to "fs"
```

For each environment you would like to use GridFS (development/test/production), add the following to `config/environments/[ENVIRONMENT].rb`:

```rb
# Store files in GridFS.
config.active_storage.service = :gridfs
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. 

To set up the dummy project for testing, run:

```sh
cd test/dummy
bin/rails active_storage:install
bin/rails db:migrate
```

Then, run `bundle exec rake test` 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`.