Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add Dockerfile and update README for Docker setup #94

Merged
merged 2 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ========================
# Build Stage
# ========================
FROM rust:1.81.0-alpine3.20 AS builder
FROM rust:1.82.0-alpine3.20 AS builder

# Install build dependencies, including static OpenSSL libraries
RUN apk add --no-cache \
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ Try the [web app demo](https://app.pkarr.org).

Or if you prefer Rust [Examples](./pkarr/examples)

## Docker Setup
To build and run the Pkarr server using Docker, follow these steps:

1. **Build the Docker image**:
```bash
docker build -t pkarr-server .
```

2. Run the Docker container:
```bash
docker run -p 6881:6881 --name pkarr-server-container pkarr-server
```

This will make the Pkarr server accessible at http://localhost:6881.

## TOC
- [Architecture](#Architecture)
- [Expectations](#Expectations)
Expand Down Expand Up @@ -158,3 +173,6 @@ Open social networks often attempt to solve discovery natively within their netw
- Their infrastructure would need to become a gossip overlay network, which may not be desirable.
- Achieving consistency and load balancing would require further optimization, effectively reinventing a DHT.
- If an overlay network is developed that surpasses the performance of a 10-million-node DHT with a 15-year track record, Pkarr should still be capable of utilizing your network as a backend, either as an alternative or alongside existing solutions.

3. **How can I run the Pkarr server using Docker?**
To run the server with Docker, build the image and start the container using the instructions in the [Docker Setup](#docker-setup) section.