3pp-mirror/neko
1
0
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2025-06-14 16:52:47 +02:00
Code Issues Projects Releases Packages Wiki Activity

add docker images and docker run docs.

Browse source
This commit is contained in:
Miroslav Šedivý 2025-02-16 18:28:33 +01:00
parent 70b9992a59
commit d22f014fc6
11 changed files with 570 additions and 250 deletions
Download patch file Download diff file Expand all files Collapse all files

10
webpage/docs/getting-started/quick-start-guide.md
View file

@ -6,7 +6,7 @@ sidebar_position: 2
Neko is easy to use and requires no technical expertise to get started. All you need to do is download the Docker image and you're ready to go:
1. Deploy a server or VPS with public IP address.
1. Deploy a server or VPS with a public IP address.
**Recommended Specs:**
@ -23,7 +23,7 @@ Neko is easy to use and requires no technical expertise to get started. All you
:::
:::note
Admin can change the resolution in the GUI.
The admin can change the resolution in the GUI.
:::
2. [Login via SSH](https://www.digitalocean.com/docs/droplets/how-to/connect-with-ssh/).
@ -39,7 +39,7 @@ Neko is easy to use and requires no technical expertise to get started. All you
sudo apt-get install docker-compose-plugin
```
5. Download docker compose file and start it:
5. Download the docker compose file and start it:
```shell
wget https://raw.githubusercontent.com/m1k1o/neko/master/docker-compose.yaml
sudo docker compose up -d
@ -49,13 +49,13 @@ Neko is easy to use and requires no technical expertise to get started. All you
If you want to run Neko on your local network, you have to add `NEKO_NAT1TO1=<your-local-ip>` to the `docker-compose.yaml` file.
:::
6. Visit the IP address server in your browser and login, the default password is `neko`.
6. Visit the server's IP address in your browser and log in, the default password is `neko`.
:::tip
Run `nano docker-compose.yaml` to edit the settings, then press `ctrl+x` to exit and save the file.
:::
## Well known cloud providers
## Well-known cloud providers
* [Hetzner Cloud](https://www.hetzner.com/cloud)
* [Digital Ocean](https://www.digitalocean.com/)
* [Contabo](https://contabo.com/)