Fix stuff
Change old repo link, minor improvements
This commit is contained in:
parent
5207e745a7
commit
8139b5ed61
21
README.md
21
README.md
@ -3,32 +3,33 @@ This is the official Docker image for NamelessMC. Deploy with ease!
|
|||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
## Install Docker
|
## # Install Docker
|
||||||
Obviously, if you wanna use Docker for deployment, you need to install Docker.
|
Obviously, if you wanna use Docker for deployment, you need to install Docker.
|
||||||
|
|
||||||
You have to manually install Docker first if you don't have it installed on your server. Check out the official install guide here: https://docs.docker.com/engine/installation.
|
You have to manually install Docker first if you don't have it installed on your server. Check out the official install guide here: https://docs.docker.com/engine/installation.
|
||||||
|
|
||||||
If you want to specify the version of NamelessMC you want, head to https://github.com/BirkhoffLee/NamelessMC-docker#manually-run-commands.
|
If you want to specify the version of NamelessMC you want, head to https://github.com/NamelessMC/Nameless-Docker#manually-run-commands.
|
||||||
|
|
||||||
|
## # Automated deployment
|
||||||
|
You will need to install [Docker Compose](https://docs.docker.com/compose/) for automated deploying. If you don't have it installed, run the following:
|
||||||
|
|
||||||
## Automated deployment
|
|
||||||
You will need to install `docker-compose` for automated deploying. If you don't have it installed, run the following:
|
|
||||||
```
|
```
|
||||||
$ curl -L "https://github.com/docker/compose/releases/download/1.11.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
|
$ curl -L "https://github.com/docker/compose/releases/download/1.11.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
|
||||||
$ chmod +x /usr/local/bin/docker-compose
|
$ chmod +x /usr/local/bin/docker-compose
|
||||||
```
|
```
|
||||||
|
|
||||||
> Note: If you get a “Permission denied” error while running the commands above, please add `sudo` at the start of them and run again. This will require sudo access.
|
> If you got a “Permission denied” error while running the commands above, add `sudo` at the beginning of each of them and run again. This will require sudo access.
|
||||||
|
|
||||||
When you're done, clone this repository and run! (`-d` means detach mode, e.g. run in background)
|
When you're done, clone this repository and run! (`-d` means detach mode, e.g. run in background)
|
||||||
```
|
```
|
||||||
$ git clone https://github.com/BirkhoffLee/NamelessMC-docker
|
$ git clone https://github.com/NamelessMC/Nameless-Docker
|
||||||
$ cd NamelessMC-docker
|
$ cd NamelessMC-docker
|
||||||
$ docker-compose up -d
|
$ docker-compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, the NamelessMC will then running on `0.0.0.0:80`! Open `http://<your-server-ip-address>` on your browser. Instead, if you're trying on your personal computer, open `http://localhost` then.
|
When the container is up, follow the guide at https://github.com/NamelessMC/Nameless-Docker#namelessmc-installation.
|
||||||
|
|
||||||
## Manually run commands
|
## # Manually run commands
|
||||||
If you more like to run the containers by yourself or using them with other containers like [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy), you may want to do it yourself.
|
If you more like to run the containers by yourself or using them with other containers like [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy), you may want to do it yourself.
|
||||||
|
|
||||||
First, clone the repository:
|
First, clone the repository:
|
||||||
@ -61,7 +62,7 @@ $ docker run -d -p 80:80 --link nameless_db --name nameless namelessmc
|
|||||||
|
|
||||||
That's it!
|
That's it!
|
||||||
|
|
||||||
# NamelessMC Installation
|
# # NamelessMC Installation
|
||||||
After deploying the containers, open up the corresponding URL in your web browser to get started with NamelessMC.
|
After deploying the containers, open up the corresponding URL in your web browser to get started with NamelessMC.
|
||||||
|
|
||||||
By default, the web server will be available at `0.0.0.0:80`, means if you deployed it on you own computer, the URL is gonna be `http://localhost`. Instead, if you did it on a remote server, the URL would be `http://<your-server-ip-addr>`.
|
By default, the web server will be available at `0.0.0.0:80`, means if you deployed it on you own computer, the URL is gonna be `http://localhost`. Instead, if you did it on a remote server, the URL would be `http://<your-server-ip-addr>`.
|
||||||
@ -71,4 +72,4 @@ Follow the install instructions. When the database configuration page shows up,
|
|||||||
When you're done, submit and follow the rest of installation.
|
When you're done, submit and follow the rest of installation.
|
||||||
|
|
||||||
# About
|
# About
|
||||||
This repository was moved from [Birkhoff Lee](https://github.com/BirkhoffLee), and the original repository is here: https://github.com/BirkhoffLee/namelessmc-docker, carefully made in Taiwan. :heart:
|
This repository was moved from [Birkhoff Lee](https://github.com/BirkhoffLee), and the original repository is here: https://github.com/BirkhoffLee/namelessmc-docker, carefully made in Taiwan. :heart:
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user