Added some instructions to the README
This commit is contained in:
@@ -1,2 +1,57 @@
|
||||
# finger
|
||||
A silly finger service written in c++20
|
||||
|
||||
# Compiling:
|
||||
|
||||
```
|
||||
meson setup builddir
|
||||
meson compile -C builddir
|
||||
```
|
||||
|
||||
This will create a static linked binary called `builddir/finger`. You can copy this to your remote server if you're going to run it via docker.
|
||||
|
||||
# Building a Dockerfile
|
||||
|
||||
Create a `Dockerfile` with the contents:
|
||||
|
||||
```
|
||||
# Use a minimal base image
|
||||
FROM alpine:latest
|
||||
|
||||
# Copy the local binary to the container
|
||||
COPY finger /usr/local/bin/finger
|
||||
|
||||
# Make the binary executable
|
||||
RUN chmod +x /usr/local/bin/finger
|
||||
|
||||
# Create the directory for user data
|
||||
RUN mkdir -p /var/finger/users
|
||||
|
||||
# Expose port 79 (finger protocol)
|
||||
EXPOSE 79
|
||||
|
||||
# Set the binary as the default command
|
||||
CMD ["finger"]
|
||||
```
|
||||
|
||||
And execute `docker build -t finger-app .`
|
||||
|
||||
# Running
|
||||
|
||||
Create a `docker-compose.yml` file:
|
||||
```
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
finger:
|
||||
build: .
|
||||
ports:
|
||||
- "79:79"
|
||||
volumes:
|
||||
- ./users:/var/finger/users
|
||||
restart: unless-stopped
|
||||
```
|
||||
and execute `docker compose up -d`
|
||||
|
||||
# Setting your status
|
||||
within the `./users` directory, create a file named after the user you wish to have a response. That's it!
|
||||
|
||||
Reference in New Issue
Block a user