Getting Started

This is the official documentation of the agent_ruby Ruby agent.

After doing the quick start, you should have a development project which is up and running and connected to your main data storage system.

However, you can plug as many data sources as you want into the same agent.

What can I connect to?

Forest Admin collections map to any of those concepts:

  • ORM models

  • Endpoints on SaaS providers (by writing a custom data source)

  • Endpoints on your own API (by writing a custom data source)

Example

def self.setup!
  database_configuration = Rails.configuration.database_configuration
  datasource = ForestAdminDatasourceActiveRecord::Datasource.new(database_configuration[Rails.env])

  @create_agent = ForestAdminAgent::Builder::AgentFactory.instance.add_datasource(datasource)
  customize
  @create_agent.build
end

def self.customize; end

Last updated