Project: forest_liana - The Ruby Toolbox

Forest v1 agent for Ruby on Rails (forest_liana gem).

Important

This is the Forest v1 agent for Rails, in maintenance mode. It receives fixes but no new features. Starting a new project? Use agent-ruby, the current Ruby agent. Already on forest_liana? Follow the v1 to v2 migration guide.

Quick start

# Gemfile
gem 'forest_liana'

bundle install
bundle exec rails generate forest_liana:install <FOREST_ENV_SECRET>

The generator mounts the engine on /forest, writes config/secrets.yml and creates the initializer:

# config/initializers/forest_liana.rb
ForestLiana.env_secret  = Rails.application.secrets.forest_env_secret
ForestLiana.auth_secret = Rails.application.secrets.forest_auth_secret

Full guide: docs.forest.app/legacy/ruby-agent/how-tos/setup/install

Requirements


Rails	`>= 6.1.7.9`
Ruby	tested in CI on 3.3

How it works

The gem, mounted in your Rails app, generates the admin API on your servers; Forest calls it over HTTPS.

The gem runs inside your Rails application. It introspects your ActiveRecord models and generates the admin API on your servers. The Forest interface calls this API: your data does not go through Forest.

Documentation


Install	https://docs.forest.app/legacy/ruby-agent/how-tos/setup/install
v1 reference guide	https://docs.forest.app/legacy/ruby-agent/reference-guide/models/overview
Upgrade notes	https://docs.forest.app/legacy/ruby-agent/how-tos/maintain/upgrade-notes-rails/upgrade-to-v9
Agents overview	https://docs.forest.app/legacy/agents-overview
Migrating to v2	https://docs.forest.app/guides/migration/from-v1/overview

Contributing

Bug fixes are welcome; new features go to agent-ruby. See CONTRIBUTING.md for setup, tests and commit conventions.

RAILS_ENV=test bundle exec rake --trace db:migrate test; bundle exec rspec

License

Apache 2.0. See LICENSE.