-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update to include installer and update advanced YAML options (#…
…2631) * docs: update quickstart and advanced sections Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: improvements Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * examples(kubernete): add nvidia example Signed-off-by: Ettore Di Giacinto <mudler@localai.io> --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
- Loading branch information
Showing
11 changed files
with
668 additions
and
448 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
|
||
+++ | ||
disableToc = false | ||
title = "Installer options" | ||
weight = 24 | ||
+++ | ||
|
||
An installation script is available for quick and hassle-free installations, streamlining the setup process for new users. | ||
|
||
Can be used with the following command: | ||
```bash | ||
curl https://localai.io/install.sh | sh | ||
``` | ||
|
||
Installation can be configured with Environment variables, for example: | ||
|
||
```bash | ||
curl https://localai.io/install.sh | VAR=value sh | ||
``` | ||
|
||
List of the Environment Variables: | ||
| Environment Variable | Description | | ||
|----------------------|--------------------------------------------------------------| | ||
| **DOCKER_INSTALL** | Set to "true" to enable the installation of Docker images. | | ||
| **USE_AIO** | Set to "true" to use the all-in-one LocalAI Docker image. | | ||
| **API_KEY** | Specify an API key for accessing LocalAI, if required. | | ||
| **CORE_IMAGES** | Set to "true" to download core LocalAI images. | | ||
| **PORT** | Specifies the port on which LocalAI will run (default is 8080). | | ||
| **THREADS** | Number of processor threads the application should use. Defaults to the number of logical cores minus one. | | ||
| **VERSION** | Specifies the version of LocalAI to install. Defaults to the latest available version. | | ||
| **MODELS_PATH** | Directory path where LocalAI models are stored (default is /usr/share/local-ai/models). | | ||
|
||
We are looking into improving the installer, and as this is a first iteration any feedback is welcome! Open up an [issue](https://github.com/mudler/LocalAI/issues/new/choose) if something doesn't work for you! |
2 changes: 1 addition & 1 deletion
2
.../docs/getting-started/run-other-models.md → ...content/docs/advanced/run-other-models.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
+++ | ||
disableToc = false | ||
title = "Run other Models" | ||
weight = 3 | ||
weight = 23 | ||
icon = "rocket_launch" | ||
|
||
+++ | ||
|
Oops, something went wrong.