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

Conversation

MiguelMedeiros
Copy link
Member

@MiguelMedeiros MiguelMedeiros commented Nov 4, 2024

@SHAcollision I saw your branch feat/dockerfile after I did my own dockerfile! hahaha 😅

So I've added a few instrucions in the readme and made this PR, feel free to delete it if you think your docker image has a better performance! 🚀

Description

This pull request introduces a Docker setup for the Pkarr server, allowing it to be built and run in a containerized environment. The changes include:

  • Dockerfile: Added a multi-stage Dockerfile for building and running the Pkarr server with optimized image size.
  • Configuration: The config.toml file is copied to the container for seamless server configuration.
  • Documentation: Updated instructions will be provided on how to build and run the Pkarr server using Docker.

Motivation

Containerizing the Pkarr server simplifies deployment and provides a consistent runtime environment. This helps both developers and users by making it easier to run the server locally or in production with minimal setup.

Changes

  • Added Dockerfile to the project root.
  • Instructions for building and running the server with Docker.

How to Test

Build the Docker image:

docker build -t pkarr-server .

Run the Docker container:

docker run -p 6881:6881 --name pkarr-server-container pkarr-server

Verify the server is accessible at http://localhost:6881.

Checklist

  • Added Dockerfile.

  • Update README with Docker instructions.

  • Ensure the container runs as expected with the default configuration.

Feel free to modify or expand this description to fit any additional details you wish to include.

@MiguelMedeiros MiguelMedeiros added the enhancement New feature or request label Nov 4, 2024
@MiguelMedeiros MiguelMedeiros self-assigned this Nov 4, 2024
@MiguelMedeiros MiguelMedeiros changed the base branch from main to feat/dockerfile November 4, 2024 16:11
@SHAcollision SHAcollision merged commit 49d4512 into feat/dockerfile Nov 4, 2024
@Nuhvi Nuhvi deleted the feat/dockerfile-new branch November 17, 2024 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants