indifferentketchup/iblogs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: rename mclogs filenames, asset paths, and runtime identifiers

Browse Source 
Two file renames (docker/mclogs.ini -> docker/iblogs.ini,
web/public/css/mclogs.css -> web/public/css/iblogs.css) plus the
internal references that pointed at them (Dockerfile COPY directive,
the linux user name in the container).

Also catches the runtime identifier renames: env-var prefix MCLOGS_*
-> IBLOGS_* (compose files), browser cookie name MCLOGS_SETTINGS ->
IBLOGS_SETTINGS (web/public/js/log.js), production image tag
ghcr.io/aternosorg/mclogs:2 -> ghcr.io/indifferentketchup/iblogs:2,
and the README walk-through with the new branding.

example.config.json branding strings (legal contact, mclo.gs frontend
name) and visible UI text (taglines, meta descriptions) are deferred
to a separate branding commit.
This commit is contained in:
indifferentketchup
2026-05-01 22:11:46 +00:00
parent 4aeebf3732
commit 8f0b067e38
7 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Dockerfile
View File

@@ -3,7 +3,7 @@ FROM dunglas/frankenphp:1-php8.5
# System Setup # System Setup
RUN install-php-extensions mongodb zip RUN install-php-extensions mongodb zip
ARG USER=mclogs ARG USER=iblogs
RUN useradd ${USER} && \ RUN useradd ${USER} && \
setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/frankenphp setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/frankenphp
@@ -20,7 +20,7 @@ RUN --mount=type=cache,target=/tmp/cache/composer \
# Application Setup # Application Setup
COPY docker/Caddyfile /etc/frankenphp/Caddyfile COPY docker/Caddyfile /etc/frankenphp/Caddyfile
COPY docker/mclogs.ini /usr/local/etc/php/conf.d/mclogs.ini COPY docker/iblogs.ini /usr/local/etc/php/conf.d/iblogs.ini
COPY . . COPY . .

40
README.md
View File

@@ -22,34 +22,34 @@
* Open source and self-hostable * Open source and self-hostable
## Self-hosting ## 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`. You can self-host iblogs using Docker. A [docker image](https://github.com/indifferentketchup/iblogs/pkgs/container/iblogs) is available in the GitHub Container Registry: `ghcr.io/indifferentketchup/iblogs`.
A MongoDB instance is also required to run mclogs. A MongoDB instance is also required to run iblogs.
An example docker compose files for self-hosting can be found here: [docker/compose.production.yaml](docker/compose.production.yaml). An example docker compose files for self-hosting can be found here: [docker/compose.production.yaml](docker/compose.production.yaml).
### Config ### 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 You can configure iblogs 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. environment variables. Environment variables override settings in the config file.
Here is a list of all available config options: Here is a list of all available config options:
| Variable / JSON Path | Default | Description | | Variable / JSON Path | Default | Description |
|:--------------------------------------------------------------------|:--------------------|:--------------------------------------------| |:--------------------------------------------------------------------|:--------------------|:--------------------------------------------|
| `MCLOGS_STORAGE_TTL` <br> `storage.ttl` | `7776000` (90d) | Time until logs are deleted after last view | | `IBLOGS_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 | | `IBLOGS_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 | | `IBLOGS_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 | | `IBLOGS_MONGODB_URL` <br> `mongodb.url` | `"mongodb://mongo"` | MongoDB connection URL |
| `MCLOGS_MONGODB_DATABASE` <br> `mongodb.database` | `"mclogs"` | Name of the MongoDB database | | `IBLOGS_MONGODB_DATABASE` <br> `mongodb.database` | `"iblogs"` | Name of the MongoDB database |
| `MCLOGS_ID_LENGTH` <br> `id.length` | `7` | The default length for new IDs | | `IBLOGS_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 | | `IBLOGS_LEGAL_ABUSE` <br> `legal.abuse` | `null` | Public email address to report abuse |
| `MCLOGS_LEGAL_IMPRINT` <br> `legal.imprint` | `null` | The imprint URL | | `IBLOGS_LEGAL_IMPRINT` <br> `legal.imprint` | `null` | The imprint URL |
| `MCLOGS_LEGAL_PRIVACY` <br> `legal.privacy` | `null` | The privacy policy URL | | `IBLOGS_LEGAL_PRIVACY` <br> `legal.privacy` | `null` | The privacy policy URL |
| `MCLOGS_FRONTEND_NAME` <br> `frontend.name` | `null` | Instance name (defaults to domain) | | `IBLOGS_FRONTEND_NAME` <br> `frontend.name` | `null` | Instance name (defaults to domain) |
| `MCLOGS_FRONTEND_COLOR_ACCENT` <br> `frontend.color.accent` | `#5cb85c` | The accent/primary color | | `IBLOGS_FRONTEND_COLOR_ACCENT` <br> `frontend.color.accent` | `#5cb85c` | The accent/primary color |
| `MCLOGS_FRONTEND_COLOR_BACKGROUND` <br> `frontend.color.background` | `#1a1a1a` | The background color | | `IBLOGS_FRONTEND_COLOR_BACKGROUND` <br> `frontend.color.background` | `#1a1a1a` | The background color |
| `MCLOGS_FRONTEND_COLOR_TEXT` <br> `frontend.color.text` | `#e8e8e8` | The text color | | `IBLOGS_FRONTEND_COLOR_TEXT` <br> `frontend.color.text` | `#e8e8e8` | The text color |
| `MCLOGS_FRONTEND_COLOR_ERROR` <br> `frontend.color.error` | `#f62451` | The error color | | `IBLOGS_FRONTEND_COLOR_ERROR` <br> `frontend.color.error` | `#f62451` | The error color |
| `MCLOGS_WORKER_REQUESTS` <br> `worker.requests` | `500` | Max requests per single worker | | `IBLOGS_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: There are a few more environment variables that can be set to modify the FrankenPHP/Caddy setup directly:
@@ -69,10 +69,10 @@ There are a few more environment variables that can be set to modify the Franken
### Installation ### Installation
```bash ```bash
# clone repository # clone repository
git clone git@github.com:aternosorg/mclogs.git git clone git@github.com:indifferentketchup/iblogs.git
# install composer dependencies # install composer dependencies
cd mclogs cd iblogs
composer install composer install
# start development environment # start development environment

4
dev/compose.yaml
View File

@@ -1,11 +1,11 @@
name: "mclogs" name: "iblogs"
services: services:
web: web:
build: build:
context: .. context: ..
dockerfile: ./Dockerfile dockerfile: ./Dockerfile
environment: environment:
- MCLOGS_WORKER_REQUESTS=1 - IBLOGS_WORKER_REQUESTS=1
- FRANKENPHP_WORKERS=4 - FRANKENPHP_WORKERS=4
ports: ports:
- "80:80" - "80:80"

12
docker/compose.production.yaml
View File

@@ -1,6 +1,6 @@
services: services:
web: web:
image: ghcr.io/aternosorg/mclogs:2 image: ghcr.io/indifferentketchup/iblogs:2
restart: always restart: always
ports: ports:
# Expose HTTP (80) and HTTPS (443) # Expose HTTP (80) and HTTPS (443)
@@ -9,16 +9,16 @@ services:
- "443:443" - "443:443"
- "443:443/udp" - "443:443/udp"
environment: environment:
# Set this to your domain (e.g., mclogs.example.com) to enable Auto-SSL. # Set this to your domain (e.g., iblogs.example.com) to enable Auto-SSL.
# If running behind a proxy (Cloudflare/Nginx), set to ":80" to disable Auto-SSL. # If running behind a proxy (Cloudflare/Nginx), set to ":80" to disable Auto-SSL.
SERVER_NAME: :80 SERVER_NAME: :80
MCLOGS_MONGODB_URL: mongodb://mongo:27017 IBLOGS_MONGODB_URL: mongodb://mongo:27017
MCLOGS_MONGODB_DATABASE: mclogs IBLOGS_MONGODB_DATABASE: iblogs
# Optional MCLOGS configuration # Optional IBLOGS configuration
# See README.md for full list of available options # See README.md for full list of available options
# MCLOGS_FRONTEND_NAME: "mclogs" # IBLOGS_FRONTEND_NAME: "iblogs"
volumes: volumes:
# For caddy cache (SSL certificates) # For caddy cache (SSL certificates)

0
docker/mclogs.ini → docker/iblogs.ini
View File

0
web/public/css/mclogs.css → web/public/css/iblogs.css
View File

2
web/public/js/log.js
View File

@@ -203,7 +203,7 @@ function saveSettings() {
for (const checkbox of settingCheckboxes) { for (const checkbox of settingCheckboxes) {
data[checkbox.dataset.key] = checkbox.checked; data[checkbox.dataset.key] = checkbox.checked;
} }
document.cookie = "MCLOGS_SETTINGS=" + encodeURIComponent(JSON.stringify(data)) + ";path=/;expires=" + new Date(new Date().getTime() + 100 * 365 * 24 * 60 * 60 * 1000).toUTCString(); document.cookie = "IBLOGS_SETTINGS=" + encodeURIComponent(JSON.stringify(data)) + ";path=/;expires=" + new Date(new Date().getTime() + 100 * 365 * 24 * 60 * 60 * 1000).toUTCString();
} }
/* copy to clipboard */ /* copy to clipboard */