README.md
Rama master · réplica de lectura del repositorio original.
# JunimoServer
<!-- Project -->
[](https://github.com/stardew-valley-dedicated-server/server/releases/latest) [](https://hub.docker.com/r/sdvd/server/tags)  [](https://github.com/stardew-valley-dedicated-server/server/actions/workflows/codeql.yml) [](https://pub-8b02482b459740d1b403ddbc47d0b817.r2.dev/e2e/master/latest/index.html) [](https://discord.gg/w23GVXdSF7)
**JunimoServer** makes [Stardew Valley](https://www.stardewvalley.net/) multiplayer hosting simple and flexible. Host your farm anytime, anywhere — on your local machine, a VPS, or a dedicated server.
This open-source project enables 24/7 multiplayer farms without needing to keep the game running on your machine. Players can connect at any time without requiring you to be online. With customizable settings, automated backups, and support for larger farms, JunimoServer makes multiplayer management easier than ever.
### Table of Contents
<!-- REGENERATE TOC: npx markdown-toc -i README.md -->
<!-- toc -->
- [Features](#features)
- [Quick start](#quick-start)
- [Prerequisites](#prerequisites)
- [Getting started](#getting-started)
- [Updating to a new version](#updating-to-a-new-version)
- [Using preview releases](#using-preview-releases)
- [Documentation](#documentation)
- [Support](#support)
<!-- tocstop -->
## Features
JunimoServer gives you everything you need to host Stardew Valley:
- **Always-On Hosting**: Keep your farm running 24/7 without needing to leave the game open.
- **Easy Management**: Control your server through a simple, web-based interface with admin capabilities.
- **Persistent Progress**: Protect your crops and ensure your farm continues to thrive, even when no one’s online.
- **Automatic Backups**: Regularly save your farm so you can easily restore it if something goes wrong.
- **Fully Customizable**: Change game modes, tweak settings, and optimize performance to fit your needs.
- **Mod-Friendly**: Supports SMAPI mods to enhance your Stardew Valley experience with customizations and extra content.
## Quick start
### Prerequisites
- **Docker**: Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) (Windows/Mac) or [Docker Engine](https://docs.docker.com/engine/install/) (Linux)
- **Steam account**: A Steam account that owns Stardew Valley (required to download game files)
### Getting started
1. **Create Configuration**:
Create a new server folder with the config files:
```sh
curl -fsSL https://docs.junimoserver.com/install.sh | bash
cd junimoserver
```
On Windows: `powershell -c "irm https://docs.junimoserver.com/install.ps1 | iex"`, then `cd junimoserver`.
Then edit `.env` and configure your server. Here is a minimal example:
```sh
# Steam Account Details (required for downloading the game server)
STEAM_USERNAME=""
STEAM_PASSWORD=""
# VNC Server (for web-based administration access)
VNC_PASSWORD=""
# HTTP API key (the server won't start until VNC_PASSWORD and API_KEY are set)
API_KEY=""
```
2. **First-Time Setup**:
Run the interactive setup to authenticate with Steam:
```sh
docker compose run --rm -it steam-auth setup
```
This will prompt you for Steam Guard authentication if enabled on your account, and downloads the game files. Once Steam can log in without prompts, a fresh server downloads the game files itself on first start.
3. **Start the Server**:
To start the server as a background process, run `docker compose up -d`.
To see logs, run `docker compose logs -f`.
4. **Stop the Server**:
To save and stop the server, run `docker compose down`.
Your save files and Steam session are stored in Docker volumes (`saves` and `steam-session`) and persist across restarts.
### Updating to a new version
When a new version is released, run the same script from your server folder:
```sh
curl -fsSL https://docs.junimoserver.com/install.sh | bash
```
On Windows: `powershell -c "irm https://docs.junimoserver.com/install.ps1 | iex"`
This pulls the new image and installs the matching `docker-compose.yml`, then asks before restarting to apply it; a run with no terminal (or with `NO_TTY=1`) restarts automatically. Your `.env`, saves, and settings are untouched. Keep your own compose changes in a `docker-compose.override.yml` (see [Upgrading](https://docs.junimoserver.com/admins/operations/upgrading)).
### Using preview releases
> **Note:** JunimoServer is under heavy development. If the `latest` release isn't working for you, try the preview release; it often contains fixes that haven't been officially released yet. As the project matures, `latest` releases will become more reliable.
Preview builds are published automatically with every code change. To use a preview release, add this to your `.env` file:
```sh
# Use the latest preview build
IMAGE_VERSION=preview
```
To switch back to `latest`, remove the line or set it to `latest`:
```sh
IMAGE_VERSION=latest
```
After changing the version, run the update command above. It pulls the matching image and `docker-compose.yml` for whichever `IMAGE_VERSION` you set (`latest`, `preview`, or pinned).
You can also pin to a specific version (e.g., `IMAGE_VERSION=1.0.0` or `IMAGE_VERSION=1.1.0-preview.3`). Check [Docker Hub](https://hub.docker.com/r/sdvd/server/tags) for available tags.
## Documentation
Explore the [full documentation](https://docs.junimoserver.com/) to get started. Here's what you'll find:
- **[Getting Started](https://docs.junimoserver.com/admins/quick-start/installation):** Step-by-step instructions on setting up and managing your server.
- **[Server Guide](https://docs.junimoserver.com/players/):** Learn how to use and manage your server.
- **[Community](https://docs.junimoserver.com/community/getting-help):** Find out how to get involved and get help.
## Support
JunimoServer is free and open-source, maintained in spare time. If it keeps your farm running and you'd like to give something back, donations help cover **server/hosting costs** and **development time** — entirely optional, always appreciated. 🌱
- **[GitHub Sponsors](https://github.com/sponsors/JulianVallee)** — monthly or one-time, 100% goes to development.
- **[Ko-fi](https://ko-fi.com/junimoserver)** — buy the project a coffee (one-time, PayPal or card).
Not in a position to donate? Starring the repo, reporting bugs, improving the docs, or helping others on [Discord](https://discord.gg/w23GVXdSF7) helps just as much.