mclogs 2.0.0

.dockerignore

@@ -0,0 +1,4 @@
+vendor/
+.git/
+.github/
+Dockerfile

.github/workflows/publish.yml

@@ -0,0 +1,67 @@
+name: Publish Docker Image
+
+on:
+  push:
+    branches:
+      - 'two'
+      - 'main'
+    tags:
+      - 'v*'
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels)
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            # Branch Name (e.g. 'two', 'main')
+            type=ref,event=branch
+            # Full Version (e.g. '1.2.3')
+            type=semver,pattern={{version}}
+            # Major Version (e.g. '1')
+            type=semver,pattern={{major}}
+            # Major.Minor (e.g. '1.2')
+            type=semver,pattern={{major}}.{{minor}}
+            # Latest (Only on release tags)
+            type=raw,value=latest,enable=${{ startsWith(github.ref, 'refs/tags/v') }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+          cache-from: |
+            type=gha
+            type=gha,scope=refs/heads/main
+          cache-to: type=gha,mode=max

.gitignore

@@ -1,4 +1,4 @@
 *.log
 .idea
 /vendor/
-core/config/mongo.php
+config.json

Dockerfile

@@ -0,0 +1,38 @@
+FROM dunglas/frankenphp:1-php8.5
+
+# System Setup
+RUN install-php-extensions mongodb zip
+
+ARG USER=mclogs
+RUN useradd ${USER} && \
+    setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/frankenphp
+
+COPY --from=composer/composer:2-bin /composer /usr/bin/composer
+
+WORKDIR /app
+
+# Dependencies (Cached)
+COPY composer.json composer.lock ./
+
+RUN --mount=type=cache,target=/tmp/cache/composer \
+    COMPOSER_CACHE_DIR=/tmp/cache/composer \
+    composer install --no-dev --no-interaction --no-scripts --no-autoloader --prefer-dist --ignore-platform-req=ext-frankenphp
+
+# Application Setup
+COPY docker/Caddyfile /etc/frankenphp/Caddyfile
+COPY docker/mclogs.ini /usr/local/etc/php/conf.d/mclogs.ini
+
+COPY . .
+
+RUN composer dump-autoload --optimize --no-dev --classmap-authoritative
+
+# Permissions & Runtime
+RUN chown -R ${USER}:${USER} /config/caddy /data/caddy /app
+
+USER ${USER}
+
+EXPOSE 80
+EXPOSE 443
+EXPOSE 443/udp
+
+VOLUME ["/data"]

README.md

@@ -1,28 +1,81 @@
-# mclo.gs
-**Paste, share & analyse your Minecraft logs**
-
-## About
-The project [mclo.gs](https://mclo.gs) was created in 2017 by the Aternos team after more 
-than 4 years of running free Minecraft servers and supporting users with 
-their problems. One of the main issues was the impossibility to easily share 
-the main source of errors: The Minecraft server log file. mclo.gs solves this 
-problem and even goes one step further with providing syntax highlighting and 
-suggestions based on the log content to simply solve common errors.
+<p align="center">
+    <img src="web/public/img/logo.svg" width="260">
+</p>
+<p align="center">
+    <strong>Paste, share & analyse your logs</strong><br>
+    Built for Minecraft & Hytale
+</p>
 
 ## Features
-* Copy + paste log sharing
-* Simple API for easy integration
+* Share logs by pasting or uploading files
+* Automatic removal of sensitive information (e.g. IP addresses)
+* Short URLs for easy sharing
 * Syntax highlighting
 * Line numbers
+* Direct links to specific lines
 * Analysis and parsing using [codex](https://github.com/aternosorg/codex-minecraft)
-* Different storage backends (mongodb, redis, filesystem)
+
+### For developers
+* Upload your logs using the API
+* Add metadata to shared logs, e.g. version numbers, server ids, etc.
+* Retrieve logs and their metadata from the API
+* Open source and self-hostable
+
+## Self-hosting
+You can self-host mclogs using Docker. A [docker image](https://github.com/aternosorg/mclogs/pkgs/container/mclogs) is available in the GitHub Container Registry: `ghcr.io/aternosorg/mclogs`. 
+A MongoDB instance is also required to run mclogs.
+
+An example docker compose files for self-hosting can be found here: [docker/compose.production.yaml](docker/compose.production.yaml).
+
+### Config
+You can configure mclogs by creating a `config.json` file in the root directory, see [example.config.json](example.config.json) or by setting
+environment variables. Environment variables override settings in the config file.
+
+Here is a list of all available config options:
+
+| Variable / JSON Path                                                | Default             | Description                                 |
+|:--------------------------------------------------------------------|:--------------------|:--------------------------------------------|
+| `MCLOGS_STORAGE_TTL` <br> `storage.ttl`                             | `7776000` (90d)     | Time until logs are deleted after last view |
+| `MCLOGS_STORAGE_LIMIT_BYTES` <br> `storage.limit.bytes`             | `10485760` (10 MiB) | Maximum size of a log in bytes              |
+| `MCLOGS_STORAGE_LIMIT_LINES` <br> `storage.limit.lines`             | `25000`             | Maximum number of lines in a log            |
+| `MCLOGS_MONGODB_URL` <br> `mongodb.url`                             | `"mongodb://mongo"` | MongoDB connection URL                      |
+| `MCLOGS_MONGODB_DATABASE` <br> `mongodb.database`                   | `"mclogs"`          | Name of the MongoDB database                |
+| `MCLOGS_ID_LENGTH` <br> `id.length`                                 | `7`                 | The default length for new IDs              |
+| `MCLOGS_LEGAL_ABUSE` <br> `legal.abuse`                             | `null`              | Public email address to report abuse        |
+| `MCLOGS_LEGAL_IMPRINT` <br> `legal.imprint`                         | `null`              | The imprint URL                             |
+| `MCLOGS_LEGAL_PRIVACY` <br> `legal.privacy`                         | `null`              | The privacy policy URL                      |
+| `MCLOGS_FRONTEND_NAME` <br> `frontend.name`                         | `null`              | Instance name (defaults to domain)          |
+| `MCLOGS_FRONTEND_COLOR_ACCENT` <br> `frontend.color.accent`         | `#5cb85c`           | The accent/primary color                    |
+| `MCLOGS_FRONTEND_COLOR_BACKGROUND` <br> `frontend.color.background` | `#1a1a1a`           | The background color                        |
+| `MCLOGS_FRONTEND_COLOR_TEXT` <br> `frontend.color.text`             | `#e8e8e8`           | The text color                              |
+| `MCLOGS_FRONTEND_COLOR_ERROR` <br> `frontend.color.error`           | `#f62451`           | The error color                             |
+| `MCLOGS_WORKER_REQUESTS` <br> `worker.requests`                     | `500`               | Max requests per single worker              |
+
+There are a few more environment variables that can be set to modify the FrankenPHP/Caddy setup directly:
+
+| Variable             | Default | Description                                                                                                                                |
+|----------------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| `SERVER_NAME`        | `":80"` | Set the Caddy server name, set this to your domain for [automatic SSL](https://caddyserver.com/docs/automatic-https#hostname-requirements) |
+| `FRANKENPHP_WORKERS` | `16`    | The number of [FrankenPHP workers](https://frankenphp.dev/docs/worker/)                                                                    |                                                                                                                                            |
+
 
 ## Development setup
-* Install Docker Compose: https://docs.docker.com/compose/install/
-* Clone repository: `git clone [URL]`
-* `cd mclogs/docker`
-* `docker-compose up`
-* Open http://localhost in browser and enjoy
-
-## License
-mclo.gs is open source software released under the MIT license, see [license](LICENSE).
+### Prerequisites
+* [Docker](https://www.docker.com/get-started/) and [Docker Compose](https://docs.docker.com/compose/install/)
+* [PHP 8.5+](https://www.php.net/downloads)
+* [Composer](https://getcomposer.org/download/)
+
+### Installation
+```bash
+# clone repository
+git clone git@github.com:aternosorg/mclogs.git
+
+# install composer dependencies
+cd mclogs
+composer install
+
+# start development environment
+cd dev
+docker compose up
+```
+Open http://localhost in browser and enjoy.