diff --git a/README.md b/README.md index dbc4744..ba03ced 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ simple dashboard to view those results. ## Hosted -There is an instance of MonDash running on [www.mondash.org](https://www.mondash.org/) you can use for free. This means you can just head over there, create your own dashboard with one click and start to push your own metrics to your dashboard within 5 minutes. No registration, no fees, just your dashboard and you. +There is an instance of MonDash running on [mondash.org](https://mondash.org/) you can use for free. This means you can just head over there, create your own dashboard with one click and start to push your own metrics to your dashboard within 5 minutes. No registration, no fees, just your dashboard and you. ## Installation @@ -20,7 +20,7 @@ MonDash needs some environment variables set when running: + `AWS_ACCESS_KEY_ID` - Your AWS Access-Key with access to the `S3Bucket` + `AWS_SECRET_ACCESS_KEY` - Your AWS Secret-Access-Key with access to the `S3Bucket` + `S3Bucket` - The S3 bucket used to store the dashboard metrics -+ `BASE_URL` - The Base-URL the application is running on for example `https://www.mondash.org` ++ `BASE_URL` - The Base-URL the application is running on for example `https://mondash.org` + `API_TOKEN` - API Token used for the /welcome dashboard (you can choose your own) ## Security diff --git a/apiary.apib b/apiary.apib index 62db6f8..f3fc1a8 100644 --- a/apiary.apib +++ b/apiary.apib @@ -1,5 +1,5 @@ FORMAT: 1A -HOST: https://www.mondash.org +HOST: https://mondash.org # MonDash MonDash is a service for everyone having to display monitoring results to people who have not @@ -10,8 +10,8 @@ results. For the API to work you will need the APIToken assigned to your dashboard. This token is displayed on the dashboard itself as long as no metrics are available to display. -To start just create a [randomly named dashboard](https://www.mondash.org/create) or start with a -named dashboard by simply visiting https://www.mondash.org/mydashboardname (if you plan to use the +To start just create a [randomly named dashboard](https://mondash.org/create) or start with a +named dashboard by simply visiting https://mondash.org/mydashboardname (if you plan to use the named version please pay attention this will be easily guessable and you data is lesser protected than with the random naming. diff --git a/docker/README.md b/docker/README.md index efaa006..f42e444 100644 --- a/docker/README.md +++ b/docker/README.md @@ -21,7 +21,7 @@ docker run \ -e AWS_ACCESS_KEY_ID=myaccesskeyid \ -e AWS_SECRET_ACCESS_KEY=mysecretaccesskey \ -e S3Bucket=mybucketname \ - -e BASE_URL=http://www.mondash.org \ + -e BASE_URL=http://mondash.org \ -e API_TOKEN=yourownrandomtoken \ -p 80:3000 \ luzifer/mondash