iridium/neko
2
2
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2024-07-24 14:40:50 +12:00
Code Issues Packages Projects Releases Wiki Activity

rename to m1k1o.

Browse Source
This commit is contained in:
Miroslav Šedivý
2021-10-05 22:32:46 +02:00
parent 028f3be2be
commit 3342dc6819
8 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@ -1,5 +1,5 @@
<div align="center">
<a href="https://n.eko.moe/#/" ><img src="https://raw.githubusercontent.com/nurdism/neko/master/docs/_media/logo.png" width="450" height="auto"/></a>
<a href="https://neko.m1k1o.net/#/" ><img src="https://raw.githubusercontent.com/m1k1o/neko/master/docs/_media/logo.png" width="450" height="auto"/></a>
<br/>
<br/>
<img src="https://i.imgur.com/ZSzbQr7.gif" width="650" height="auto"/>

2
docs/_coverpage.md
View File

@ -4,7 +4,7 @@
> A self hosted virtual browser that runs in docker
[GitHub](https://github.com/nurdism/neko/)
[GitHub](https://github.com/m1k1o/neko/)
[Get Started](#neko)
<!-- background color -->

2
docs/contributing.md
View File

@ -1,5 +1,5 @@
# Contributing
* Fork the [project](https://github.com/nurdism/neko).
* Fork the [project](https://github.com/m1k1o/neko).
* Edit files in your branch.
* Submit a pull request explaining the improvements.

4
docs/docker.md
View File

@ -3,13 +3,13 @@
## Running:
### Chromium container:
```
sudo docker run -p 80:8080 -p 59000-59100:59000-59100/udp -e NEKO_PASSWORD='secret' -e NEKO_PASSWORD_ADMIN='secret' --cap-add SYS_ADMIN --shm-size=1gb nurdism/neko:chromium
sudo docker run -p 80:8080 -p 59000-59100:59000-59100/udp -e NEKO_PASSWORD='secret' -e NEKO_PASSWORD_ADMIN='secret' --cap-add SYS_ADMIN --shm-size=1gb m1k1o/neko:chromium
```
*Note:* `--cap-add SYS_ADMIN` & `--shm-size=1gb` is required for chromium to run properly
----
### Firefox container:
```
sudo docker run -p 8080:8080 -p 59000-59100:59000-59100/udp -e NEKO_PASSWORD='secret' -e NEKO_PASSWORD_ADMIN='secret' --shm-size=1gb nurdism/neko:firefox
sudo docker run -p 8080:8080 -p 59000-59100:59000-59100/udp -e NEKO_PASSWORD='secret' -e NEKO_PASSWORD_ADMIN='secret' --shm-size=1gb m1k1o/neko:firefox
```
*Note:* `--shm-size=1gb` is required for firefox, tabs will crash otherwise

2
docs/index.html
View File

@ -29,7 +29,7 @@
maxLevel: 4,
subMaxLevel: 2,
name: 'neko',
repo: 'nurdism/neko',
repo: 'm1k1o/neko',
themeColor: '#19bd9c'
}
</script>

2
docs/quick-start.md
View File

@ -25,7 +25,7 @@
```shell
sudo ufw allow 80/tcp # if you have ufw installed/enabled
sudo ufw allow 59000:59100/udp
wget https://raw.githubusercontent.com/nurdism/neko/master/.examples/simple/docker-compose.yaml
wget https://raw.githubusercontent.com/m1k1o/neko/master/.examples/simple/docker-compose.yaml
sudo docker-compose up -d
```
5. Visit the IP address server in your browser and login, the default password is `neko`