https://github.com/amphi2024/server
A simple Minecraft-like self-hosted server for Amphi Notes, Music, Photos, and Cloud.
https://github.com/amphi2024/server
amphi amphi-cloud amphi-music amphi-notes amphi-photos amphi-server decentralized file-sharing free-software kotlin minecraft-server open-source opensource self-hosting sharing vertx
Last synced: about 1 month ago
JSON representation
A simple Minecraft-like self-hosted server for Amphi Notes, Music, Photos, and Cloud.
- Host: GitHub
- URL: https://github.com/amphi2024/server
- Owner: amphi2024
- License: agpl-3.0
- Created: 2024-11-10T02:56:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-01T07:57:20.000Z (about 2 months ago)
- Last Synced: 2026-02-01T18:30:02.557Z (about 2 months ago)
- Topics: amphi, amphi-cloud, amphi-music, amphi-notes, amphi-photos, amphi-server, decentralized, file-sharing, free-software, kotlin, minecraft-server, open-source, opensource, self-hosting, sharing, vertx
- Language: Kotlin
- Homepage: https://amphi.site/server
- Size: 10.1 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Amphi Server
[notes]: https://github.com/amphi2024/notes
[music]: https://github.com/amphi2024/music
[photos]: https://github.com/amphi2024/photos
[cloud]: https://github.com/amphi2024/cloud
A simple Minecraft-like self-hosted server for [Amphi Notes][notes], [Music][music], [Photos][photos], and [Cloud][cloud].
## Setup
You can host your server using Java Runtime. If this guide feels complicated, check out our step-by-step [YouTube Tutorial](https://www.youtube.com/@amphi2024).
[//]: # (You can host your server using Java Runtime or Docker. If this guide feels complicated, check out our step-by-step [YouTube Tutorial](https://www.youtube.com/@amphi2024).)
[//]: # (### Start with Java)
First, download the server from GitHub Releases.
```bash
curl -L https://github.com/amphi2024/server/releases/download/v?.?.?/server-?.?.?.jar -o server.jar
# Replace ?.?.? with the latest version
```
Initialize the server:
```bash
java -jar server.jar
```
`config.example.yaml` will be generated. Rename it to `config.yaml` and customize your settings.
Run as a Linux Service (Systemd): Create a file at `/etc/systemd/system/your-server.service`:
```ini
[Unit]
Description=My Server
After=network.target
[Service]
Type=simple
User=YOU
WorkingDirectory=/path/to/server
ExecStart=java -jar /path/to/server/server.jar # or path/to/jre/bin/java -jar /path/to/server/server.jar
Restart=on-failure
[Install]
WantedBy=multi-user.target
```
Apply and start:
```bash
sudo systemctl daemon-reload
sudo systemctl enable your-server
sudo systemctl start your-server
```
[//]: # (### Start with Docker)
[//]: # (If you want a containerized server. )
[//]: # (First, pull the image.)
[//]: # (```bash)
[//]: # (docker pull amphi/server:latest)
[//]: # (```)
[//]: # (Then, run the server:)
[//]: # (```bash)
[//]: # (docker run -d \)
[//]: # ( -p 8000:8000 \)
[//]: # ( -v $(pwd)/data:/app/data \)
[//]: # ( -v $(pwd)/config.yaml:/app/config.yaml \)
[//]: # ( --name amphi-server \)
[//]: # ( amphi/server:latest)
[//]: # (```)
### Final Step
To access your server from outside your network, we recommend the following methods:
- Tailscale
- Cloudflare Tunnel
- Ngrok
- Custom Domain with HTTPS
**WARNING**: Ensure your configuration is secure according to your chosen method. Avoid risky methods like direct port forwarding.
## Update
You can easily update the server by replacing the JAR file.
[//]: # (### For Java Users)
```bash
# Stop the Service (for Linux)
sudo systemctl stop your-server
# Rename the old server file
mv server.jar server-old.jar
# Download the latest version
curl -L https://github.com/amphi2024/server/releases/download/v?.?.?/server-?.?.?.jar -o server.jar
# Restart the Service
sudo systemctl restart your-server
```
[//]: # (### For Docker Users)
[//]: # (```bash)
[//]: # ()
[//]: # (```)