Skip to content

Commit d0d9f8b

Browse files
committed
updated readme docker usage
Signed-off-by: Sean Porter <portertech@gmail.com>
1 parent dcc635b commit d0d9f8b

1 file changed

Lines changed: 53 additions & 10 deletions

File tree

README.md

Lines changed: 53 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,23 @@ A secure, high-performance [Model Context Protocol](https://modelcontextprotocol
1414

1515
## Installation
1616

17+
### Docker (Recommended)
18+
19+
The easiest way to run the server is with Docker:
20+
21+
```bash
22+
docker pull portertech/filesystem-mcp-server
23+
```
24+
25+
See the [Docker Usage](#docker-usage) section for configuration examples.
26+
27+
### Go Install
28+
1729
```bash
1830
go install github.com/portertech/filesystem-mcp-server/cmd/filesystem@latest
1931
```
2032

21-
Or build from source:
33+
### Build from Source
2234

2335
```bash
2436
git clone https://github.com/portertech/filesystem-mcp-server.git
@@ -30,16 +42,16 @@ make build
3042

3143
```bash
3244
# Start server with allowed directories
33-
./filesystem /path/to/allowed/dir1 /path/to/allowed/dir2
45+
filesystem /path/to/allowed/dir1 /path/to/allowed/dir2
3446

3547
# Enable verbose logging
36-
./filesystem -verbose /path/to/dir
48+
filesystem -verbose /path/to/dir
3749

3850
# Show version
39-
./filesystem -version
51+
filesystem -version
4052

4153
# List allowed directories
42-
./filesystem -list /path/to/dir
54+
filesystem -list /path/to/dir
4355
```
4456

4557
## Available Tools
@@ -298,6 +310,27 @@ This server sets [MCP Tool Annotations](https://modelcontextprotocol.io/specific
298310

299311
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
300312

313+
#### Using Docker (Recommended)
314+
315+
```json
316+
{
317+
"mcpServers": {
318+
"filesystem": {
319+
"command": "docker",
320+
"args": [
321+
"run", "-i", "--rm",
322+
"-v", "/Users/username/Documents:/Users/username/Documents",
323+
"-v", "/Users/username/Projects:/Users/username/Projects",
324+
"portertech/filesystem-mcp-server",
325+
"/Users/username/Documents", "/Users/username/Projects"
326+
]
327+
}
328+
}
329+
}
330+
```
331+
332+
#### Using Binary
333+
301334
```json
302335
{
303336
"mcpServers": {
@@ -312,14 +345,24 @@ Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
312345
}
313346
```
314347

315-
## Docker
348+
## Docker Usage
316349

317-
```bash
318-
# Build
319-
docker build -t filesystem-mcp-server .
350+
Running the server in Docker provides an additional layer of security through container isolation, limiting the agent's access to only the mounted directories. Mirror host paths in your volume mounts (e.g., `-v /path:/path` instead of `-v /path:/data`) so the AI agent sees the same paths you reference in conversation.
320351

352+
```bash
321353
# Run with mounted directories
322-
docker run -v /host/path:/data filesystem-mcp-server /data
354+
docker run -i \
355+
-v /path/to/dir:/path/to/dir \
356+
portertech/filesystem-mcp-server /path/to/dir
357+
358+
# Multiple directories
359+
docker run -i \
360+
-v /home/user/projects:/home/user/projects \
361+
-v /home/user/documents:/home/user/documents \
362+
portertech/filesystem-mcp-server /home/user/projects /home/user/documents
363+
364+
# Build locally (optional)
365+
docker build -t filesystem-mcp-server .
323366
```
324367

325368
## Security

0 commit comments

Comments
 (0)