Skip to content

Commit

Permalink
Getting Started cleaned up
Browse files Browse the repository at this point in the history
Moved the parts about netvips to the FAQ. Makes the landing page cleaner.
  • Loading branch information
DieselTech committed Feb 5, 2024
1 parent 709e696 commit d61fec6
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
16 changes: 5 additions & 11 deletions pages/installation/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,15 @@ import { Callout } from 'nextra-theme-docs'

## System Requirements

Kavita can run on a wide varity of devices but your experience will generally be better the more resources you have. Your media files don't need to be on a SSD, but keeping your Kavita database file on a SSD will greatly increase performance of the application.
Kavita can run on a wide varity of devices but your experience will be better the more resources you have. Your media files don't need to be on a SSD, but keeping your Kavita database file on a SSD will greatly increase performance of the application. Users have reported running the app on as little as a single core 1Ghz CPU and 256MB RAM.

Due to the upstream library `NetVips`, the only requirement to run kavita is a CPU that supports [SSE4.2](https://en.wikipedia.org/wiki/SSE4) for cover generation. Almost all modern CPU's made in the last 10 years support this.
The only requirement Kavita has is the need for CPU that supports SSE4.2 extensions. This is because of the upstream library `NetVIPS`. [See the FAQ](../troubleshooting/faq.mdx#q-what-is-the-netvips-dependency-and-what-does-it-mean-if-i-cant-run-it) for how to work around it.

If you have an Intel CPU, you can check if your device is supported by looking in [Intel's ARC database](https://ark.intel.com/content/www/us/en/ark.html#@Processors) for your CPU. "Instruction Set Extensions" should list SSE4.2

AMD users can check [wikipedia for their arcitecture](https://en.wikipedia.org/wiki/List_of_AMD_CPU_microarchitectures) to see if there is support.

Users have reported memory usage averages 150-350MB depending on the size of your library. Spikes in memory will occur after scanning but will go back down over time as garbage collection runs.
Users have reported memory usage averages 150-350MB depending on the size of your library. Spikes in memory will occur after scanning but will go back down over time.

## Supported Browsers

Kavita uses Angular, which supports up to the [2 most recent versions of a web browser](https://angular.io/guide/browser-support) If you use an older web browser you may have compatibility issues, or worst case, not be able to load Kavita at all due to incompatibility.
Kavita uses Angular, which supports up to the [2 most recent versions of a web browser](https://angular.io/guide/browser-support). If you use an older web browser you may have compatibility issues, or worst case, not be able to load Kavita at all due to incompatibility.

## Demo

Expand All @@ -33,6 +29,4 @@ There are a few ways to get setup running kavita depending on what enviroment yo

1. Install using [Docker](/installation/docker)
2. Install using a [pre-compiled executable](/installation/native) for your operating system
3. Install on your [NAS or storage applicance](/installation/nas)


3. Install on your [NAS or storage applicance](/installation/nas)
10 changes: 10 additions & 0 deletions pages/troubleshooting/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ A. By default, Kavita will collect stats on your installation. This will run aft
}
```

#### Q. What is the `NetVips` dependency and what does it mean if I can't run it?

A. Kavita uses the `NetVips` [package](https://github.com/kleisauke/net-vips) to handle all the image processing tasks. That means if your CPU isn't supported you'll either outright crash or have bad looking black & white images.

If you have an Intel CPU, you can check if your device is supported by looking in [Intel's ARC database](https://ark.intel.com/content/www/us/en/ark.html#@Processors) for your CPU. "Instruction Set Extensions" should list SSE4.2

AMD users can check [wikipedia for their arcitecture](https://en.wikipedia.org/wiki/List_of_AMD_CPU_microarchitectures) to see if there is support.

If you are running on an older device that doesn't meet the requirement you can try the steps outlined here: [Github Ticket](https://github.com/Kareadita/Kavita/issues/1423)

#### Q. Is there a way to use Kavita without Authentication?
A. No, this type of functionality is not supported and there are no plans. Kavita offers Refresh Tokens which should keep you authenticated without having to manually log in. You can also use your apiKey to auto-login to your account via url (url/login?apiKey=XXX).

Expand Down

0 comments on commit d61fec6

Please sign in to comment.