outline-mcp-server 5.5.5 → 5.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -135,6 +135,45 @@ Example queries your AI assistant can now handle:
|
|
|
135
135
|
- "Update the content of a document"
|
|
136
136
|
- "Add a comment to a document"
|
|
137
137
|
|
|
138
|
+
## Docker Usage
|
|
139
|
+
|
|
140
|
+
You can run the Outline MCP Server using Docker or Docker Compose for easy deployment.
|
|
141
|
+
|
|
142
|
+
### 1. Prepare your `.env` file
|
|
143
|
+
|
|
144
|
+
Copy `.env.example` to `.env` and fill in your Outline API key:
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
cp .env.example .env
|
|
148
|
+
# Edit .env and set OUTLINE_API_KEY=your_outline_api_key_here
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### 2. Build and run with Docker Compose (recommended)
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
docker-compose up --build
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
- The server will be available on port 6060 by default.
|
|
158
|
+
- Environment variables are loaded from your `.env` file.
|
|
159
|
+
|
|
160
|
+
### 3. Build and run manually with Docker
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
docker build -t outline-mcp-server .
|
|
164
|
+
docker run --env-file .env -p 6060:6060 outline-mcp-server
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
- You can override environment variables at runtime with `-e` flags if needed.
|
|
168
|
+
|
|
169
|
+
### 4. Customizing
|
|
170
|
+
|
|
171
|
+
- To change the API URL, set `OUTLINE_API_URL` in your `.env` file or as an environment variable.
|
|
172
|
+
- To change the port or host, set `OUTLINE_MCP_PORT` and `OUTLINE_MCP_HOST` in your `.env` file or as environment variables.
|
|
173
|
+
- For more advanced setups, edit `docker-compose.yml` as needed.
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
138
177
|
## Development
|
|
139
178
|
|
|
140
179
|
```bash
|