AI/ragflow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-08-14 05:55:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

How to make your changes to vm.max_map_count persistent on macOS (#2041)

Browse Source 
### What problem does this PR solve?

#1919 

### Type of change
- [x] Documentation Update
This commit is contained in:
writinwaters 2024-08-21 19:27:25 +08:00 committed by GitHub
parent 0f95086813
commit c5c3240c4c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 48 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/quickstart.mdx
View File

@ -67,16 +67,61 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
``` ```
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
If you are on macOS with Docker Desktop, then you *must* use docker-machine to update `vm.max_map_count`: If you are on macOS with Docker Desktop, run the following command to update `vm.max_map_count`:
```bash ```bash
$ docker-machine ssh docker run --rm --privileged --pid=host alpine sysctl -w vm.max_map_count=262144
$ sudo sysctl -w vm.max_map_count=262144
``` ```
:::caution WARNING :::caution WARNING
This change will be reset after a system reboot. If you forget to update the value the next time you start up the server, you may get a `Can't connect to ES cluster` exception. This change will be reset after a system reboot. If you forget to update the value the next time you start up the server, you may get a `Can't connect to ES cluster` exception.
::: :::
To make your change persistent, create a file with proper settings:
1.1. Create a file:
```shell
sudo nano /Library/LaunchDaemons/com.user.vmmaxmap.plist
```
1.2. Open the file:
```shell
sudo launchctl load /Library/LaunchDaemons/com.user.vmmaxmap.plist
```
1.3. Add settings:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>com.user.vmmaxmap</string>
<key>ProgramArguments</key>
<array>
<string>/usr/sbin/sysctl</string>
<string>-w</string>
<string>vm.max_map_count=262144</string>
</array>
<key>RunAtLoad</key>
<true/>
</dict>
</plist>
```
1.4. After saving the file, load the new daemon:
```shell
sudo launchctl load /Library/LaunchDaemons/com.user.vmmaxmap.plist
```
:::note
If the above steps does not work, consider using [this workaround](https://github.com/docker/for-mac/issues/7047#issuecomment-1791912053), which employs a container and does not require manual editing of the macOS settings.
:::
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">