Setup Instructions

Notebook.ai is a complex platform that's built to be somewhat modular, allowing you to set up just the features you want to use. For these setup instructions, I'll break down the setup into two separate paths:

• Minimal setup (no third-party integrations, just Notebook.ai running locally)
• Full setup (all integrations and configuration, to match https://www.notebook.ai)

Minimal setup

1. Make sure you have Ruby installed. Make sure your Ruby version matches the version specified in .ruby-version.

2. Install the necessary native libraries for your system. These are the libraries I use on Ubuntu; you may use a different package manager or have different package names on other systems.

sudo apt install imagemagick libmagickwand-dev libpq-dev

3. Clone the notebook repo

git clone [email protected]:indentlabs/notebook.git

4. Install the gems

bundle install

5. Create and prepare your database

rake db:create
rake db:migrate
rake billing_plans:initialize_defaults
rake data_migrations:create_default_billing_plans
rake db:seed

6. You can now run the server with the following command:

bundle exec rails server

Full setup

All of the above, plus...

1. To enable background jobs, you'll want to install and make sure you're running sidekiq.

bundle exec sidekiq -C config/sidekiq.yml

2. To enable document analysis,

3. To enable image uploads,

4. To enable (redis),

5. To enable email sending (password resets, collaboration invites, etc),

6. To enable Paypal payments,

7. To enable Stripe payments,

8. To enable New Relic & error reporting,

9. To enable database snapshots, recovery, and fallback,

10. To enable Slack integration,

11. To scale, I use the following architecture (set as ENV variables):

  WEB_CONCURRENCY=2
  RAILS_MAX_THREADS=16
  MALLOC_ARENA_MAX=2
  DB_POOL=25
  RUBY_GC_HEAP_GROWTH_FACTOR=1.03

TBD