MCP Obsidian Docker

🚀 MCP Obsidian Docker Version

This is a containerized version of MCP Obsidian, a server that interacts with Obsidian via the community plugin Local REST API.

🚀 Quick Start

Prerequisites

1. Docker and Docker Compose installed.
2. Obsidian with the Local REST API plugin installed and configured.
3. An API key obtained from the Local REST API plugin.

API Key Configuration

Obtain Your API Key

1. Open Obsidian.
2. Go to Settings (the gear icon at the bottom left).
3. Select "Community plugins" in the left sidebar.
4. Find "Local REST API" in the list of installed plugins.
5. Click the settings gear icon (⚙️) next to the plugin.
6. Look for the "API Key" field; this is your authentication key.

Set Your API Key

1. Create an environment file by copying the example file:

   cp .env.example .env
   

2. Edit the .env file:

   # Open with your preferred editor
   nano .env
   # Or
   vim .env
   # Or any text editor
   

3. Replace the placeholder with your actual API key:

   # Before:
   OBSIDIAN_API_KEY=your_api_key_here
   
   # After modification (example - use your actual key):
   OBSIDIAN_API_KEY=1234abcd5678efgh
   

Security Precautions

• The .env file is listed in .gitignore to prevent accidental commits.
• Never share your API key or commit it to version control.
• If you need to change your API key:
  1. Generate a new key in Obsidian.
  2. Update your .env file.
  3. Restart the container: docker-compose restart

Setup

1. Clone this repository.
2. Configure the API key as described above.
3. Build and start the container:

   docker-compose up -d
   

Usage

The MCP Obsidian server will run on port 27124. Ensure that this port matches the port configured in the Local REST API plugin in Obsidian.

Verify the Setup

1. Check if the container is running:

   docker-compose ps
   

2. View the logs to find any issues:

   docker-compose logs -f
   

3. If you see an authentication error, confirm that your API key is set correctly in the .env file.

Common Issues

1. Authentication failure: Double - check that your API key in the Obsidian plugin settings and the .env file match.
2. Connection refused: Ensure that Obsidian is running and the Local REST API plugin is enabled.
3. Port conflict: If port 27124 is already in use, you can modify the port mapping in docker-compose.yml.

Logs

Logs are stored in the ./logs directory, which is mounted as a volume to the container.

Environment Variables

• OBSIDIAN_API_KEY: Your API key for the Obsidian Local REST API plugin (required).

📄 License

This project is licensed under the MIT License - for more details, please refer to the original MCP Obsidian repository.