Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update requirements.md #3323

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update requirements.md #3323

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions doc/manual/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
### Supported Unix distributions by this guide

- Ubuntu (18.04, 16.04 and 14.04)
- Debian (Stretch and Jessie)
- Debian (Bullseye, Bookworm)

### Unsupported Unix distributions

Expand All @@ -27,7 +27,9 @@ Please consider using a virtual machine to run Huginn on Windows.

## Ruby versions

Huginn requires Ruby (MRI) 2.2 or 2.3.
Huginn requires Ruby (MRI) >= 3.2.2.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are currently at Ruby 3.2.4 and will receive teeny updates in the future, so please leave out the teeny version here.

Suggested change
Huginn requires Ruby (MRI) >= 3.2.2.
Huginn requires Ruby (MRI) >= 3.2.

On Debian Stable, you should use a Ruby Package Manager to install the latest Ruby. Apt version is too old.

You will have to use the standard MRI implementation of Ruby.
We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/) but Huginn needs several Gems that have native extensions.

Expand All @@ -44,7 +46,7 @@ We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/) but Huginn
You need at least 0.5GB of physical and 0.5GB of addressable memory (swap) to install and use Huginn with the default configuration!
With less memory you need to manually adjust the `Gemfile` and Huginn can respond with internal server errors when accessing the web interface.

- 256MB RAM + 0.5GB of swap is the absolute minimum but we strongly **advise against** this amount of memory. See the Wiki page about running Huginn on [systems with low memory](https://github.com/huginn/huginn/wiki/Running-Huginn-on-minimal-systems-with-low-RAM-&-CPU-e.g.-Raspberry-Pi)
- 256MB RAM + 0.5GB of swap is the absolute minimum but we strongly **advise against** this amount of memory. See the Wiki page about running Huginn on [systems with low memory](https://github.com/huginn/huginn/wiki/Running-Huginn-on-minimal-systems-with-low-RAM-&-CPU.g.-Raspberry-Pi)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the URL before the change is valid.

- 0.5GB RAM + 0.5GB swap will work relatively well with SSD drives, but can feel a bit slow due to swapping
- 1GB RAM + 1GB swap will work with two unicorn workers and the threaded background worker
- **2GB RAM** is the **recommended** memory size, it will support 2 unicorn workers and both the threaded and the old separate workers
Expand Down