Skip to content

Commit cc3df75

Browse files
authored
chore(docs): improve installer.sh docs (#5232)
Signed-off-by: Ettore Di Giacinto <[email protected]>
1 parent 3781610 commit cc3df75

File tree

4 files changed

+39
-7
lines changed

4 files changed

+39
-7
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,12 @@
103103
Run the installer script:
104104

105105
```bash
106+
# Basic installation
106107
curl https://localai.io/install.sh | sh
107108
```
108109

110+
For more installation options, see [Installer Options](https://localai.io/advanced/installer/).
111+
109112
Or run with docker:
110113

111114
### CPU only image:

docs/content/docs/advanced/installer.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,12 @@ List of the Environment Variables:
3434
| **FEDERATED** | Set to "true" to share the instance with the federation (p2p token is required see [documentation]({{%relref "docs/features/distributed_inferencing" %}})) |
3535
| **FEDERATED_SERVER** | Set to "true" to run the instance as a federation server which forwards requests to the federation (p2p token is required see [documentation]({{%relref "docs/features/distributed_inferencing" %}})) |
3636

37+
## Uninstallation
38+
39+
To uninstall, run:
40+
41+
```
42+
curl https://localai.io/install.sh | sh -s -- --uninstall
43+
```
44+
3745
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!

docs/content/docs/getting-started/quickstart.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,15 @@ If you are exposing LocalAI remotely, make sure you protect the API endpoints ad
1818

1919
## Quickstart
2020

21-
2221
### Using the Bash Installer
22+
2323
```bash
24+
# Basic installation
2425
curl https://localai.io/install.sh | sh
2526
```
2627

28+
See [Installer]({{% relref "docs/advanced/installer" %}}) for all the supported options
29+
2730
### Run with docker:
2831
```bash
2932
# CPU only image:

docs/static/install.sh

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
11
#!/bin/sh
2-
# This script installs LocalAI on Linux.
3-
# It detects the current operating system architecture and installs the appropriate version of LocalAI.
2+
# LocalAI Installer Script
3+
# This script installs LocalAI on Linux and macOS systems.
4+
# It automatically detects the system architecture and installs the appropriate version.
45

56
# Usage:
6-
# curl ... | ENV_VAR=... sh -
7-
# or
8-
# ENV_VAR=... ./install.sh
9-
# To uninstall: ./install.sh --uninstall
7+
# Basic installation:
8+
# curl https://localai.io/install.sh | sh
9+
#
10+
# With environment variables:
11+
# DOCKER_INSTALL=true USE_AIO=true API_KEY=your-key PORT=8080 THREADS=4 curl https://localai.io/install.sh | sh
12+
#
13+
# To uninstall:
14+
# curl https://localai.io/install.sh | sh -s -- --uninstall
15+
#
16+
# Environment Variables:
17+
# DOCKER_INSTALL - Set to "true" to install Docker images (default: auto-detected)
18+
# USE_AIO - Set to "true" to use the all-in-one LocalAI image (default: false)
19+
# API_KEY - API key for securing LocalAI access (default: none)
20+
# PORT - Port to run LocalAI on (default: 8080)
21+
# THREADS - Number of CPU threads to use (default: auto-detected)
22+
# MODELS_PATH - Path to store models (default: /usr/share/local-ai/models)
23+
# CORE_IMAGES - Set to "true" to download core LocalAI images (default: false)
24+
# P2P_TOKEN - Token for P2P federation/worker mode (default: none)
25+
# WORKER - Set to "true" to run as a worker node (default: false)
26+
# FEDERATED - Set to "true" to enable federation mode (default: false)
27+
# FEDERATED_SERVER - Set to "true" to run as a federation server (default: false)
1028

1129
set -e
1230
set -o noglob

0 commit comments

Comments
 (0)