docs: Remove pip
This commit is contained in:
@@ -36,11 +36,12 @@ OAuth2/OIDC provides secure, per-user authentication with access tokens. See [Au
|
|||||||
### 1. Install
|
### 1. Install
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Using uv (recommended)
|
# Clone the repository
|
||||||
uv pip install nextcloud-mcp-server
|
git clone https://github.com/cbcoutinho/nextcloud-mcp-server.git
|
||||||
|
cd nextcloud-mcp-server
|
||||||
|
|
||||||
# Or using pip
|
# Install with uv (recommended)
|
||||||
pip install nextcloud-mcp-server
|
uv sync
|
||||||
|
|
||||||
# Or using Docker
|
# Or using Docker
|
||||||
docker pull ghcr.io/cbcoutinho/nextcloud-mcp-server:latest
|
docker pull ghcr.io/cbcoutinho/nextcloud-mcp-server:latest
|
||||||
|
|||||||
+48
-89
@@ -12,20 +12,21 @@ This guide covers installing the Nextcloud MCP server on your system.
|
|||||||
|
|
||||||
Choose one of the following installation methods:
|
Choose one of the following installation methods:
|
||||||
|
|
||||||
- [Using uv (Recommended)](#using-uv-recommended)
|
- [From Source (Recommended)](#from-source-recommended)
|
||||||
- [Using pip](#using-pip)
|
|
||||||
- [Using Docker](#using-docker)
|
- [Using Docker](#using-docker)
|
||||||
- [From Source](#from-source)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Using uv (Recommended)
|
## From Source (Recommended)
|
||||||
|
|
||||||
[uv](https://github.com/astral-sh/uv) is a fast Python package installer and resolver.
|
Install from the GitHub repository using uv or pip.
|
||||||
|
|
||||||
### Install uv
|
### Prerequisites
|
||||||
|
|
||||||
|
Install [uv](https://github.com/astral-sh/uv) (recommended) or ensure pip is available:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Install uv (recommended)
|
||||||
# On macOS/Linux
|
# On macOS/Linux
|
||||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||||
|
|
||||||
@@ -33,37 +34,46 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
|
|||||||
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
|
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install Nextcloud MCP Server
|
### Clone the Repository
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install from PyPI
|
git clone https://github.com/cbcoutinho/nextcloud-mcp-server.git
|
||||||
uv pip install nextcloud-mcp-server
|
cd nextcloud-mcp-server
|
||||||
|
```
|
||||||
|
|
||||||
# Or install directly using uvx
|
### Install Dependencies
|
||||||
uvx nextcloud-mcp-server --help
|
|
||||||
|
#### Using uv (Recommended)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install dependencies
|
||||||
|
uv sync
|
||||||
|
|
||||||
|
# Install development dependencies (optional)
|
||||||
|
uv sync --group dev
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Using pip
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Create virtual environment
|
||||||
|
python3 -m venv venv
|
||||||
|
source venv/bin/activate # On Windows: venv\Scripts\activate
|
||||||
|
|
||||||
|
# Install in development mode
|
||||||
|
pip install -e .
|
||||||
|
|
||||||
|
# Install development dependencies (optional)
|
||||||
|
pip install -e ".[dev]"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Verify Installation
|
### Verify Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# With uv
|
||||||
uv run nextcloud-mcp-server --help
|
uv run nextcloud-mcp-server --help
|
||||||
```
|
|
||||||
|
|
||||||
---
|
# With pip/venv
|
||||||
|
|
||||||
## Using pip
|
|
||||||
|
|
||||||
Standard installation using pip:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Create a virtual environment (recommended)
|
|
||||||
python3 -m venv venv
|
|
||||||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
|
||||||
|
|
||||||
# Install from PyPI
|
|
||||||
pip install nextcloud-mcp-server
|
|
||||||
|
|
||||||
# Verify installation
|
|
||||||
nextcloud-mcp-server --help
|
nextcloud-mcp-server --help
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -117,55 +127,6 @@ docker-compose up -d
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## From Source
|
|
||||||
|
|
||||||
Install from the GitHub repository:
|
|
||||||
|
|
||||||
### Clone the Repository
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/cbcoutinho/nextcloud-mcp-server.git
|
|
||||||
cd nextcloud-mcp-server
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install Dependencies
|
|
||||||
|
|
||||||
#### Using uv (Recommended)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install dependencies
|
|
||||||
uv sync
|
|
||||||
|
|
||||||
# Install development dependencies (optional)
|
|
||||||
uv sync --group dev
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Using pip
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Create virtual environment
|
|
||||||
python3 -m venv venv
|
|
||||||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
|
||||||
|
|
||||||
# Install in development mode
|
|
||||||
pip install -e .
|
|
||||||
|
|
||||||
# Install development dependencies (optional)
|
|
||||||
pip install -e ".[dev]"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Verify Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# With uv
|
|
||||||
uv run nextcloud-mcp-server --help
|
|
||||||
|
|
||||||
# With pip
|
|
||||||
nextcloud-mcp-server --help
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
After installation:
|
After installation:
|
||||||
@@ -176,31 +137,29 @@ After installation:
|
|||||||
|
|
||||||
## Updating
|
## Updating
|
||||||
|
|
||||||
### Update with uv
|
### Update from Source
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv pip install --upgrade nextcloud-mcp-server
|
cd nextcloud-mcp-server
|
||||||
```
|
git pull origin master
|
||||||
|
|
||||||
### Update with pip
|
# Using uv
|
||||||
|
uv sync
|
||||||
|
|
||||||
```bash
|
# Or using pip
|
||||||
pip install --upgrade nextcloud-mcp-server
|
pip install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
### Update Docker Image
|
### Update Docker Image
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull ghcr.io/cbcoutinho/nextcloud-mcp-server:latest
|
docker pull ghcr.io/cbcoutinho/nextcloud-mcp-server:latest
|
||||||
|
|
||||||
|
# If using docker-compose
|
||||||
docker-compose up -d # Restart with new image
|
docker-compose up -d # Restart with new image
|
||||||
```
|
|
||||||
|
|
||||||
### Update from Source
|
# If using docker run
|
||||||
|
# Stop the old container and start a new one with the updated image
|
||||||
```bash
|
|
||||||
cd nextcloud-mcp-server
|
|
||||||
git pull origin master
|
|
||||||
uv sync # or: pip install -e .
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Troubleshooting Installation
|
## Troubleshooting Installation
|
||||||
|
|||||||
Reference in New Issue
Block a user