Skip to content

Commit

Permalink
Update README, fixed formatting added comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
InfinityDevTech committed Jun 11, 2024
1 parent 652e941 commit 49b0a07
Showing 1 changed file with 28 additions and 26 deletions.
54 changes: 28 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,50 +24,54 @@ A. MMO:

```json
{
"prefix": "a.b.c",
"username": "PandaMaster",
"type": "mmo",
"shards": ["shard0"],
"token": "TOKEN_FOR_THIS_USER!",
# Prefix is entirely optional
"prefix": "a.b.c",
"username": "PandaMaster",
"type": "mmo",
"shards": ["shard0"],
"token": "TOKEN_FOR_THIS_USER!",
}
```

B. Private:

```json
{
"prefix": "a.b.c",
"username": "EMAIL",
"replaceName": "USERNAME HERE",
"type": "private",
"shards": ["screeps"],
"password": "password",
# Prefix is entirely optional
"prefix": "a.b.c",
"username": "EMAIL",
# If your email has a period in it, grafana displays it incorrectly
# Its reccomended to change this to the username you set for MMO.
"replaceName": "USERNAME HERE",
"type": "private",
"shards": ["screeps"],
"password": "password",
}
```

If the private server is not hosted on localhost, add the host to the user:

```json
{
"username": "EMAIL",
"replaceName": "USERNAME",
"type": "private",
"shards": ["screeps"],
"password": "password",
"host": "192.168.1.10",
"username": "EMAIL",
"replaceName": "USERNAME",
"type": "private",
"shards": ["screeps"],
"password": "password",
"host": "192.168.1.10",
}
```

If the segment of the stats is not memory, add it to the user:

```json
{
"username": "W1N1",
"type": "private",
"shards": ["screeps"],
"password": "password",
"host": "123.456.789",
"segment": 0,
"username": "W1N1",
"type": "private",
"shards": ["screeps"],
"password": "password",
"host": "123.456.789",
"segment": 0,
}
```

Expand All @@ -81,7 +85,6 @@ Update all .example files and/or folders to match your needs. This step is not r
* `--debug`: listen to setup Docker logs
* `--username`: overwrite the username for the Grafana admin user
* `--password`: overwrite the password for the Grafana admin user
* `--defaultRetention`: overwrite the default retention for the default retention polic of all not regex'd retention paths.
* `--enableAnonymousAccess`: enable anonymous access to Grafana

#### Network
Expand All @@ -99,8 +102,7 @@ Update all .example files and/or folders to match your needs. This step is not r
## Usage

* `npm run setup`: to execute setup only
* `npm run start:standalone`: to configure and start it
* `npm run start:standalone-traefik` to confgiure with traefik and start it
* `npm run start`: to configure and start it
* For other run commands like eslint, check out package.json scripts object.

Go to [localhost:3000](http://localhost:3000) (if you used port 3000) and login with `admin` and `password` (or your custom set login info).
Expand Down

0 comments on commit 49b0a07

Please sign in to comment.