📝 Updates docs with new port number

This commit is contained in:
Alicia Sykes 2022-04-21 15:48:40 +01:00
parent 0d4d86de97
commit d64049697c
6 changed files with 18 additions and 18 deletions

View File

@ -94,7 +94,7 @@
**Screenshots**: Checkout the [Showcase](./docs/showcase.md), to see example dashboards from the community **Screenshots**: Checkout the [Showcase](./docs/showcase.md), to see example dashboards from the community
**Spin up your own demo**: [![One-Click Deploy with PWD](https://img.shields.io/badge/Play--with--Docker-Deploy-2496ed?style=flat-square&logo=docker)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml) or [`docker run -p 8080:80 lissy93/dashy`](./docs/quick-start.md) **Spin up your own demo**: [![One-Click Deploy with PWD](https://img.shields.io/badge/Play--with--Docker-Deploy-2496ed?style=flat-square&logo=docker)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml) or [`docker run -p 8080:8080 lissy93/dashy`](./docs/quick-start.md)
<p align="center"> <p align="center">

View File

@ -209,7 +209,7 @@ Allow from [your-ip]
In NGINX you can specify [control access](https://docs.nginx.com/nginx/admin-guide/security-controls/controlling-access-proxied-http/) rules for a given site in your `nginx.conf` or hosts file. For example: In NGINX you can specify [control access](https://docs.nginx.com/nginx/admin-guide/security-controls/controlling-access-proxied-http/) rules for a given site in your `nginx.conf` or hosts file. For example:
``` ```
server { server {
listen 80; listen 8080;
server_name www.dashy.example.com; server_name www.dashy.example.com;
location / { location / {
root /path/to/dashy/; root /path/to/dashy/;

View File

@ -5,7 +5,7 @@ Welcome to Dashy, so glad you're here :) Deployment is super easy, and there are
#### Quick Start #### Quick Start
If you want to skip the fuss, and [get straight down to it](/docs/quick-start.md), then you can spin up a new instance of Dashy by running: If you want to skip the fuss, and [get straight down to it](/docs/quick-start.md), then you can spin up a new instance of Dashy by running:
``` ```
docker run -p 8080:80 lissy93/dashy docker run -p 8080:8080 lissy93/dashy
``` ```
See [Management Docs](/docs/management.md) for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc See [Management Docs](/docs/management.md) for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc
@ -47,7 +47,7 @@ Dashy has a built container image hosted on [Docker Hub](https://hub.docker.com/
```docker ```docker
docker run -d \ docker run -d \
-p 8080:80 \ -p 8080:8080 \
-v /root/my-local-conf.yml:/app/public/conf.yml \ -v /root/my-local-conf.yml:/app/public/conf.yml \
--name my-dashboard \ --name my-dashboard \
--restart=always \ --restart=always \
@ -91,7 +91,7 @@ services:
# volumes: # volumes:
# - /root/my-config.yml:/app/public/conf.yml # - /root/my-config.yml:/app/public/conf.yml
ports: ports:
- 4000:80 - 4000:8080
# Set any environmental variables # Set any environmental variables
environment: environment:
- NODE_ENV=production - NODE_ENV=production
@ -136,7 +136,7 @@ Installing dashy is really simply and fast:
``` ```
docker run -d \ docker run -d \
-p 4000:80 \ -p 4000:8080 \
-v /volume1/docker/dashy/my-local-conf.yml:/app/public/conf.yml \ -v /volume1/docker/dashy/my-local-conf.yml:/app/public/conf.yml \
--name dashy \ --name dashy \
--restart=always \ --restart=always \

View File

@ -215,7 +215,7 @@ Once you've generated your SSL cert, you'll need to pass it to Dashy. This can b
``` ```
docker run -d \ docker run -d \
-p 8080:80 \ -p 8080:8080 \
-v ~/my-private-key.key:/etc/ssl/certs/dashy-priv.key:ro \ -v ~/my-private-key.key:/etc/ssl/certs/dashy-priv.key:ro \
-v ~/my-public-key.pem:/etc/ssl/certs/dashy-pub.pem:ro \ -v ~/my-public-key.pem:/etc/ssl/certs/dashy-pub.pem:ro \
lissy93/dashy:latest lissy93/dashy:latest
@ -255,7 +255,7 @@ services:
volumes: volumes:
- /root/my-config.yml:/app/public/conf.yml - /root/my-config.yml:/app/public/conf.yml
ports: ports:
- 4000:80 - 4000:8080
environment: environment:
- BASE_URL=/my-dashboard - BASE_URL=/my-dashboard
restart: unless-stopped restart: unless-stopped
@ -523,7 +523,7 @@ upstream dashy {
} }
server { server {
listen 80; listen 8080;
server_name dashy.mydomain.com; server_name dashy.mydomain.com;
# Setup SSL # Setup SSL
@ -607,7 +607,7 @@ services:
dashy: dashy:
image: lissy93/dashy image: lissy93/dashy
user: ${CURRENT_UID} user: ${CURRENT_UID}
ports: [ 4000:80 ] ports: [ 4000:8080 ]
``` ```
And then to set the variable, and start the container, run: `CURRENT_UID=$(id -u):$(id -g) docker-compose up` And then to set the variable, and start the container, run: `CURRENT_UID=$(id -u):$(id -g) docker-compose up`
@ -626,7 +626,7 @@ version: "3.8"
services: services:
dashy: dashy:
image: lissy93/dashy image: lissy93/dashy
ports: [ 4000:80 ] ports: [ 4000:8080 ]
cap_drop: cap_drop:
- ALL - ALL
cap_add: cap_add:
@ -662,7 +662,7 @@ Similarly, never expose `/var/run/docker.sock` to other containers as a volume,
You can specify that a specific volume should be read-only by appending `:ro` to the `-v` switch. For example, while running Dashy, if we want our config to be writable, but keep all other assets protected, we would do: You can specify that a specific volume should be read-only by appending `:ro` to the `-v` switch. For example, while running Dashy, if we want our config to be writable, but keep all other assets protected, we would do:
``` ```
docker run -d \ docker run -d \
-p 8080:80 \ -p 8080:8080 \
-v ~/dashy-conf.yml:/app/public/conf.yml \ -v ~/dashy-conf.yml:/app/public/conf.yml \
-v ~/dashy-icons:/app/public/item-icons:ro \ -v ~/dashy-icons:/app/public/item-icons:ro \
-v ~/dashy-theme.scss:/app/src/styles/user-defined-themes.scss:ro \ -v ~/dashy-theme.scss:/app/src/styles/user-defined-themes.scss:ro \
@ -732,8 +732,8 @@ Create a new file in `/etc/nginx/sites-enabled/dashy`
``` ```
server { server {
listen 80; listen 8080;
listen [::]:80; listen [::]:8080;
root /var/www/dashy/html; root /var/www/dashy/html;
index index.html; index index.html;
@ -847,7 +847,7 @@ Similar to above, you'll first need to fork and clone Dashy to your local system
Then, either use Dashy's default [`Dockerfile`](https://github.com/Lissy93/dashy/blob/master/Dockerfile) as is, or modify it according to your needs. Then, either use Dashy's default [`Dockerfile`](https://github.com/Lissy93/dashy/blob/master/Dockerfile) as is, or modify it according to your needs.
To build and deploy locally, first build the app with: `docker build -t dashy .`, and then start the app with `docker run -p 8080:80 --name my-dashboard dashy`. Or modify the `docker-compose.yml` file, replacing `image: lissy93/dashy` with `build: .` and run `docker compose up`. To build and deploy locally, first build the app with: `docker build -t dashy .`, and then start the app with `docker run -p 8080:8080 --name my-dashboard dashy`. Or modify the `docker-compose.yml` file, replacing `image: lissy93/dashy` with `build: .` and run `docker compose up`.
Your container should now be running, and will appear in the list when you run `docker container ls a`. If you'd like to enter the container, run `docker exec -it [container-id] /bin/ash`. Your container should now be running, and will appear in the list when you run `docker container ls a`. If you'd like to enter the container, run `docker exec -it [container-id] /bin/ash`.

View File

@ -18,7 +18,7 @@ If you don't want to use Docker, then you can use one of Dashy's other supported
To pull the latest image, and build and start the app run: To pull the latest image, and build and start the app run:
``` ```
docker run -d \ docker run -d \
-p 8080:80 \ -p 8080:8080 \
-v ~/my-conf.yml:/app/public/conf.yml \ -v ~/my-conf.yml:/app/public/conf.yml \
--name my-dashboard \ --name my-dashboard \
--restart=always \ --restart=always \

View File

@ -98,7 +98,7 @@ If you're getting an error about scenarios, then you've likely installed the wro
Alternatively, as a workaround, you have several options: Alternatively, as a workaround, you have several options:
- Try using [NPM](https://www.npmjs.com/get-npm) instead: So clone, cd, then run `npm install`, `npm run build` and `npm start` - Try using [NPM](https://www.npmjs.com/get-npm) instead: So clone, cd, then run `npm install`, `npm run build` and `npm start`
- Try using [Docker](https://www.docker.com/get-started) instead, and all of the system setup and dependencies will already be taken care of. So from within the directory, just run `docker build -t lissy93/dashy .` to build, and then use docker start to run the project, e.g: `docker run -it -p 8080:80 lissy93/dashy` (see the [deploying docs](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md#deploy-with-docker) for more info) - Try using [Docker](https://www.docker.com/get-started) instead, and all of the system setup and dependencies will already be taken care of. So from within the directory, just run `docker build -t lissy93/dashy .` to build, and then use docker start to run the project, e.g: `docker run -it -p 8080:8080 lissy93/dashy` (see the [deploying docs](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md#deploy-with-docker) for more info)
--- ---