04. Detailed Installation Guide

This section provides a thorough guide on installing PROXNUT, catering to both Docker users and those who prefer a manual setup. It ensures that users can get PROXNUT up and running with minimal hassle.

4.1 Prerequisites

Before installing PROXNUT, ensure you have the following:

• Operating System: A Linux-based OS is recommended for optimal performance and compatibility.

• Docker & Docker Compose: PROXNUT can be easily deployed using Docker. Ensure you have Docker and Docker Compose installed.

• Git: To clone the PROXNUT repository and fetch updates.

---

4.2 Docker Compose Installation

Step-by-Step Guide:

1. Clone the Repository:

   git clone https://github.com/gandlafbtc/proxnut.git

2. Navigate to the Directory:

   cd PROXNUT

3. Run Docker Compose:

   docker-compose up --build -d

4. Verify Installation:
   Access the PROXNUT interface via your browser to ensure it's running.

---

4.3 Manual Setup and Configuration

For those who prefer a manual setup:

1. Clone the Repository:

   git clone https://github.com/gandlafbtc/proxnut.git

2. Navigate to the Directory:

   cd PROXNUT

3. Configuration: find the example.env files and edit the environment variables.

4. Start the services:
   Run the services using the appropriate command, e.g., (you can find the start commands in the Dockerfile of each service)

5. Verify Installation:
   Access the service interface via your browser at http://localhost:{port} to ensure it's running.

---

4.4 Post-Installation Steps

• Set Up Resources: Define the web resources you want to protect or monetize using PROXNUT in the dashboard

• Set allowed mints: Define the Cashu mints you want to allow tokens from

• Configure Wallet extension: Link your Cashu ecash wallet to use a mint for token-based transactions.

<proxnut-wallet minturl='https://your.mint/url'></proxnut-wallet>

• Test the Setup: Try accessing a protected resource to ensure the token verification and transaction processes work seamlessly.

---