Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/themeinerlp/skinserver

A simple skin server written in spring boot and kotlin
https://github.com/themeinerlp/skinserver

hacktoberfest hacktoberfest-accepted hacktoberfest2022 minecraft mojang-api mongodb server skin spring-boot standalone-server

Last synced: 27 days ago
JSON representation

A simple skin server written in spring boot and kotlin

Host: GitHub
URL: https://github.com/themeinerlp/skinserver
Owner: TheMeinerLP
License: mit
Created: 2021-03-28T16:49:57.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2023-12-15T05:12:39.000Z (11 months ago)
Last Synced: 2023-12-15T06:28:50.415Z (11 months ago)
Topics: hacktoberfest, hacktoberfest-accepted, hacktoberfest2022, minecraft, mojang-api, mongodb, server, skin, spring-boot, standalone-server
Language: Kotlin
Homepage: https://themeinerlp.github.io/SkinServer/
Size: 3.4 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

# Skin Server
[![GitHub issues](https://img.shields.io/github/issues/TheMeinerLP/SkinServer)](https://github.com/TheMeinerLP/SkinServer/issues)
[![GitHub forks](https://img.shields.io/github/forks/TheMeinerLP/SkinServer)](https://github.com/TheMeinerLP/SkinServer/network)
[![GitHub stars](https://img.shields.io/github/stars/TheMeinerLP/SkinServer)](https://github.com/TheMeinerLP/SkinServer/stargazers)
[![GitHub license](https://img.shields.io/github/license/TheMeinerLP/SkinServer)](https://github.com/TheMeinerLP/SkinServer/blob/master/LICENSE)

This is a simple skin server to downloading, pre-caching and rendering

# Features:
- Render a skin head based on a file
- Render a skin/head based on uuid or username
- Save skins into database for long-time cache
- Token based IP Selection for mojang requests
- **Dockerized**
- **Kubernetes ready**

# Installation with Docker
Run this command to start a single instance with mongodb properties.
```shell
docker run --name skinserver \
-d \
-e SPRING_DATA_MONGODB_AUTHENTICATION-DATABASE=admin \
-e SPRING_DATA_MONGODB_DATABASE=skinserver \
-e SPRING_DATA_MONGODB_HOST=127.0.0.1 \
-e SPRING_DATA_MONGODB_PORT=27017 \
-e SPRING_DATA_MONGODB_PASSWORD=YourPassword \
-e SPRING_DATA_MONGODB_USERNAME=YourUsername \
-e SKINSERVER_MAX-SIZE=512 \
-e SKINSERVER_MIN-SIZE=16 \
-e SKINSERVER_CONNECTION-ADDRESSES_0=127.0.0.1 \
-p 8080:8080 \
ghcr.io/themeinerlp/skinserver/skinserver:latest
```
Modify your database, host, username and password for the mongodb server.
Optional: Modify SKINSERVER_MIN/MAX-SIZE and extend your IP Address Range
# Installation with Docker-Compose
Copy the content below and paste it into a `docker-compose.yaml` file
```yaml
version: '3.1'
services:
mongo:
image: mongo
restart: always
environment:
MONGO_INITDB_ROOT_USERNAME: YourUsername
MONGO_INITDB_ROOT_PASSWORD: YourPassword
MONGO_INITDB_DATABASE: SkinServer
skin-server:
image: ghcr.io/themeinerlp/skinserver/skinserver
restart: always
ports:
- 8080:8080
environment:
SPRING_DATA_MONGODB_AUTHENTICATION-DATABASE: admin
SPRING_DATA_MONGODB_DATABASE: SkinServer
SPRING_DATA_MONGODB_HOST: mongo
SPRING_DATA_MONGODB_PORT: 27017
SPRING_DATA_MONGODB_USERNAME: YourUsername
SPRING_DATA_MONGODB_PASSWORD: YourPassword
SKINSERVER_MAX-SIZE: 512
SKINSERVER_MIN-SIZE: 16
SKINSERVER_CONNECTION-ADDRESSES_0: 127.0.0.1
```
Then run following commands:
```shell
docker-compose up -d
```