Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chara White committed Jun 7, 2024
1 parent 5a802c3 commit 00be952
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,30 @@ Based on https://github.com/vital987/chrome-novnc .
Removed the Heroku keep-alive part because you can't run Grass on Heroku anyways.

## Disclaimer
You CAN get banned by getgrass if you use this project.
This project is not affiliated with getgrass in any way.

Getgrass uses your IP address to do web scraping.
You CAN get banned by getgrass if you use this project.

Unlike these python scripts which just respond to ping and don't answer to web scraping request, this project uses a chromium to run the Grass extension. Getgrass shouldn't care about using chromium, but they can. Use at your own risk.
Getgrass shouldn't care about using chromium inside a container, but they may. Use at your own risk.

## Usage

### with docker compose
`docker compose up` and access `http://localhost:8080` to access the VNC.

Login your getgrass account from the chromium browser inside the VNC, and the grass extension will be running like in a normal browser.

### with docker run
```
docker run -d -p 8080:8080 -e VNC_PASS=CHANGE_IT cwithw/grass-chrome-novnc:latest
```

Add other environment variables if needed.


## Pre built image
amd64: `cwithw/grass-chrome-novnc:latest`

arm64: `cwithw/grass-chrome-novnc:latest`

## Building
Expand Down

0 comments on commit 00be952

Please sign in to comment.