aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 88afd4c5fb0ec4d2a4b40b20fd9ab7b19ba79ca1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Mednafen Server for GNU/Debian

[![GitHub Release](https://img.shields.io/github/release/valentineus/mednafen-server.svg)](https://github.com/valentineus/mednafen-server/releases)
[![MicroBadger Layers](https://images.microbadger.com/badges/image/valentineus/mednafen-server.svg)](https://microbadger.com/images/valentineus/mednafen-server)
[![Build Status](https://travis-ci.org/valentineus/mednafen-server.svg?branch=master)](https://travis-ci.org/valentineus/mednafen-server)

Automatic build and deployment of the package `mednafen-server`.

## General use

Installation packages are available in the
[release](https://github.com/valentineus/mednafen-server/releases)
section.

After downloading the package, perform the installation:
```bash
dpkg --install mednafen-server_*_amd64.deb
```

Starting the server:
```bash
mednafen-server ./standard.conf
```

An example of the
[configuration file](standard.conf)
is in the repository.
Detailed information is available on the
[developer's website](https://mednafen.github.io/releases/#mednafen-server).

## Docker use

* Download the image:
```bash
docker pull valentineus/mednafen-server:latest
```

* Start the container:
```bash
docker run --detach --restart=unless-stopped --publish 4046:4046 --name "mednafen-server" valentineus/mednafen-server
```

More information on the
[image page](https://hub.docker.com/r/valentineus/mednafen-server/).

## License

<img height="256px" alt="GNU Banner" src="https://www.gnu.org/graphics/runfreegnu.png" />

[GNU GPLv3](LICENSE.txt).
Copyright (c)
[Valentin Popov](mailto:info@valentineus.link).