Skip to content

Commit aa8a66d

Browse files
authored
Update README.md
1 parent 7e528dc commit aa8a66d

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Monitor your render jobs from anywhere right on your phone.
3535
</p>
3636

3737
# Installation instructions (Docker)
38+
Unfortunately I can't provided a built image due to how NextJS generates static HTML at build time, which has to include the backend WebSocket URL. I've provided a docker-compose file so you can easily build and run the image yourself.
3839
1. Make sure you have the [backend for this frontend](https://github.com/BreakTools/deadline-web-app-backend) running.
3940
2. Clone this repository.
4041
```
@@ -44,26 +45,18 @@ git clone https://github.com/BreakTools/deadline-web-app-frontend
4445
```
4546
cd deadline-web-app-frontend
4647
```
47-
4. Open `.env.local` and change NEXT_PUBLIC_BACKEND_URL to the URL of your running WebSocket backend.
48-
5. Build the Docker container.
48+
4. Open `docker-compose.yml` and change the NEXT_PUBLIC_BACKEND_URL arg to the URL of your running WebSocket backend. Feel free to change the container port as well.
49+
5. Build and run the Docker container.
4950
```
50-
docker build -t deadline-web-app-frontend .
51+
docker compose up
5152
```
52-
6. Run the backend.
53-
```
54-
docker run -p 3000:3000 deadline-web-app-frontend
55-
```
56-
That's it! The backend is now running. By default it runs on port 3000, to change this you can set the `PORT` environment variable to another value, like this:
57-
```
58-
docker run -e PORT=4000 -p 4000:4000 deadline-web-app-frontend
59-
```
60-
Make sure to put this webserver behind a domain name with SSL, otherwise the desktop notifications won't work.
53+
That's it! The frontend is now running. Make sure to put this webserver behind a domain name with SSL, otherwise the desktop notifications won't work.
6154

6255
# Installation instructions (Standalone)
6356
1. Make sure you have the [backend for this frontend](https://github.com/BreakTools/deadline-web-app-backend) running.
6457
2. Make sure you have a recent version of NodeJS installed.
6558
3. Download this repository, put it in a good spot and cd into it. Run `npm install` to download all needed Node packages.
66-
4. Open `.env.local` and change NEXT_PUBLIC_BACKEND_URL to the URL of your running WebSocket backend.
59+
4. Create and open `.env.local`, add a NEXT_PUBLIC_BACKEND_URL and set it to the URL of your running WebSocket backend.
6760
5. Run `npm run build`, then run `npm run start` to start the webserver.
6861

6962
That's it! Make sure to put this webserver behind a domain name with SSL, otherwise the desktop notifications won't work.

0 commit comments

Comments
 (0)