Installation ​

Requirements ​

• Ruby on Rails >= 6.1
• Ruby >= 3
• api_only set to false. More here.
• propshaft or sprockets gem
• Have the secret_key_base defined in any of the following ENV["SECRET_KEY_BASE"], Rails.application.credentials.secret_key_base, or Rails.application.secrets.secret_key_base

# config/application.rb
config.autoloader = :zeitwerk
config.load_defaults 6.1

Installing Avo ​

Take it step by step.

1. Add the Avo gems to the Gemfile

source "https://#{ENV["AVO_GEM_TOKEN"]}@packager.fly.dev/avo-hq-beta/" do
  gem "avo", "3.0.0.pre3"
  gem "avo_pro"
  gem "avo_advanced"
  gem "avo_filters"
  gem "avo_menu"
  gem "avo_dashboards"
end

:::

1. Run bundle install.
2. Run bin/rails generate avo:install to generate the initializer and add Avo to the routes.rb file.
3. Generate an Avo Resource

Install from GitHub ​

You may also install Avo from GitHub but when you do that you must compile the assets yourself. You do that using the rake avo:build-assets command. When pushing to production, make sure you build the assets on deploy time using this task.

# Rakefile
Rake::Task["assets:precompile"].enhance do
  Rake::Task["avo:build-assets"].execute
end

Mount Avo to a subdomain ​

You can use the regular host constraint in the routes.rb file.

constraint host: 'avo' do
  mount Avo::Engine, at: '/'
end

Next steps ​

Please follow the next steps to ensure your app is secured and you have access to all the features you need.

1. Set up authentication and tell Avo who is your current_user. This step is required for the authorization feature to work.
2. Set up authorization. Don't let your data be exposed. Give users access to the data they need to see.
3. Set up licensing.