docs: fix installation instructions for official methods
- Replace pluginMarketplace with extraKnownMarketplaces - Add CLI command method (recommended) - Add settings.json method for team distribution - Add local development option - Prioritize public HTTPS URL over Tailscale SSH URL - Reorganize installation sections for clarity Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
130
README.md
130
README.md
@@ -89,67 +89,92 @@ Comprehensive NetBox REST API integration for infrastructure management.
|
|||||||
- Python 3.10+
|
- Python 3.10+
|
||||||
- Access to target services (Gitea, NetBox as needed)
|
- Access to target services (Gitea, NetBox as needed)
|
||||||
|
|
||||||
### Quick Start
|
### Add Marketplace to Claude Code
|
||||||
|
|
||||||
1. **Clone the repository:**
|
**Option 1 - CLI command (recommended):**
|
||||||
```bash
|
```bash
|
||||||
git clone ssh://git@hotserv.tailc9b278.ts.net:2222/personal-projects/support-claude-mktplace.git
|
/plugin marketplace add https://gitea.hotserv.cloud/personal-projects/support-claude-mktplace.git
|
||||||
cd support-claude-mktplace
|
```
|
||||||
```
|
|
||||||
|
|
||||||
2. **Install MCP server dependencies:**
|
**Option 2 - Settings file (for team distribution):**
|
||||||
```bash
|
|
||||||
# Gitea MCP (for projman)
|
|
||||||
cd plugins/projman/mcp-servers/gitea
|
|
||||||
python3 -m venv .venv
|
|
||||||
source .venv/bin/activate
|
|
||||||
pip install -r requirements.txt
|
|
||||||
deactivate
|
|
||||||
|
|
||||||
# NetBox MCP (for cmdb-assistant)
|
Add to `.claude/settings.json` in your target project:
|
||||||
cd ../../../cmdb-assistant/mcp-servers/netbox
|
```json
|
||||||
python3 -m venv .venv
|
{
|
||||||
source .venv/bin/activate
|
"extraKnownMarketplaces": {
|
||||||
pip install -r requirements.txt
|
"support-claude-mktplace": {
|
||||||
deactivate
|
"source": {
|
||||||
```
|
"source": "git",
|
||||||
|
"url": "https://gitea.hotserv.cloud/personal-projects/support-claude-mktplace.git"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
3. **Configure system-level credentials:**
|
**Option 3 - Local development:**
|
||||||
```bash
|
```bash
|
||||||
mkdir -p ~/.config/claude
|
# Clone the repository first
|
||||||
|
git clone https://gitea.hotserv.cloud/personal-projects/support-claude-mktplace.git
|
||||||
|
|
||||||
# Gitea credentials
|
# Then add from local path
|
||||||
cat > ~/.config/claude/gitea.env << 'EOF'
|
/plugin marketplace add /path/to/support-claude-mktplace
|
||||||
GITEA_URL=https://gitea.example.com
|
```
|
||||||
GITEA_TOKEN=your_token
|
|
||||||
GITEA_ORG=your_org
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# NetBox credentials
|
**Alternative SSH URL (for authenticated access):**
|
||||||
cat > ~/.config/claude/netbox.env << 'EOF'
|
```
|
||||||
NETBOX_API_URL=https://netbox.example.com/api
|
ssh://git@hotserv.tailc9b278.ts.net:2222/personal-projects/support-claude-mktplace.git
|
||||||
NETBOX_API_TOKEN=your_token
|
```
|
||||||
EOF
|
|
||||||
|
|
||||||
chmod 600 ~/.config/claude/*.env
|
### Configure MCP Server Dependencies
|
||||||
```
|
|
||||||
|
|
||||||
4. **Configure project-level settings:**
|
If using plugins with MCP servers (projman, cmdb-assistant), install dependencies:
|
||||||
```bash
|
|
||||||
# In your target project root
|
|
||||||
cat > .env << 'EOF'
|
|
||||||
GITEA_REPO=your-repository-name
|
|
||||||
EOF
|
|
||||||
```
|
|
||||||
|
|
||||||
5. **Add marketplace to Claude Code:**
|
```bash
|
||||||
|
# Gitea MCP (for projman)
|
||||||
|
cd plugins/projman/mcp-servers/gitea
|
||||||
|
python3 -m venv .venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
pip install -r requirements.txt
|
||||||
|
deactivate
|
||||||
|
|
||||||
Add to your project's `.claude/settings.json`:
|
# NetBox MCP (for cmdb-assistant)
|
||||||
```json
|
cd ../../../cmdb-assistant/mcp-servers/netbox
|
||||||
{
|
python3 -m venv .venv
|
||||||
"pluginMarketplace": "/path/to/support-claude-mktplace"
|
source .venv/bin/activate
|
||||||
}
|
pip install -r requirements.txt
|
||||||
```
|
deactivate
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configure Credentials
|
||||||
|
|
||||||
|
**System-level credentials:**
|
||||||
|
```bash
|
||||||
|
mkdir -p ~/.config/claude
|
||||||
|
|
||||||
|
# Gitea credentials
|
||||||
|
cat > ~/.config/claude/gitea.env << 'EOF'
|
||||||
|
GITEA_URL=https://gitea.example.com
|
||||||
|
GITEA_TOKEN=your_token
|
||||||
|
GITEA_ORG=your_org
|
||||||
|
EOF
|
||||||
|
|
||||||
|
# NetBox credentials
|
||||||
|
cat > ~/.config/claude/netbox.env << 'EOF'
|
||||||
|
NETBOX_API_URL=https://netbox.example.com/api
|
||||||
|
NETBOX_API_TOKEN=your_token
|
||||||
|
EOF
|
||||||
|
|
||||||
|
chmod 600 ~/.config/claude/*.env
|
||||||
|
```
|
||||||
|
|
||||||
|
**Project-level settings:**
|
||||||
|
```bash
|
||||||
|
# In your target project root
|
||||||
|
cat > .env << 'EOF'
|
||||||
|
GITEA_REPO=your-repository-name
|
||||||
|
EOF
|
||||||
|
```
|
||||||
|
|
||||||
## Repository Structure
|
## Repository Structure
|
||||||
|
|
||||||
@@ -217,4 +242,5 @@ MIT License
|
|||||||
## Support
|
## Support
|
||||||
|
|
||||||
- **Issues**: Contact repository maintainer
|
- **Issues**: Contact repository maintainer
|
||||||
- **Repository**: `ssh://git@hotserv.tailc9b278.ts.net:2222/personal-projects/support-claude-mktplace.git`
|
- **Repository**: `https://gitea.hotserv.cloud/personal-projects/support-claude-mktplace.git`
|
||||||
|
- **SSH URL**: `ssh://git@hotserv.tailc9b278.ts.net:2222/personal-projects/support-claude-mktplace.git`
|
||||||
|
|||||||
Reference in New Issue
Block a user