From 3ed8b58c9d117d62bc09873ba21bed7a06fafd4e Mon Sep 17 00:00:00 2001
From: Micky <60691199+AliMickey@users.noreply.github.com>
Date: Wed, 25 Dec 2024 21:34:02 +1100
Subject: [PATCH] fixes

---
 .gitignore         |  1 +
 README.md          | 38 ++++++++++++++++++++++++++------------
 docker-compose.yml | 10 ----------
 3 files changed, 27 insertions(+), 22 deletions(-)
 delete mode 100644 docker-compose.yml

diff --git a/.gitignore b/.gitignore
index 97065c0..e18f48d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,7 @@
 # Config files
 instance/*
 
+docker-compose.yml
 
 # Python
 app/__pycache__/
diff --git a/README.md b/README.md
index 5bb4076..9c03a0a 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,42 @@
 # photonglass
 A modern, distributed looking glass application that provides network insight for network operators.
 
+## See it live
+https://photonglass.dev
 
 ## Features
--**Multi-Device Support**: Connect to multiple devices from one single interface.
--**Easy Deployment**: Extremely easy to deploy and scale with multiple devices.
-
+- **Multi Device Support**: Connect to multiple devices from one single interface.
+- **Easy Deployment**: Extremely easy to deploy and scale with multiple devices.
 
 ## Setup (Docker)
 1. Clone repository
-    - `git clone https://github.com/AliMickey/photonglass.git`
+  - `git clone https://github.com/AliMickey/photonglass.git`
 2. Create an instance folder to store your config and logos
-    - `cd photonglass`
-    - `mkdir instance`
-    - `mkdir instance/images`
+  - `cd photonglass`
+  - `mkdir instance`
+  - `mkdir instance/images`
 3. Create config files and upload logos (follow config template below)
-4. Edit `docker-compose.yml` if required (images path is commented out by default)
-4. Build and deploy the container
-    - `docker compose up -d --build`
+4. Create `docker-compose.yml` (follow template below)
+4. Build and deploy the container (inital build may take a minute)
+  - `docker compose up -d --build`
 5. View the app at `http://IP_ADDRESS:5000`, recommend using a reverse proxy (traefik) for production use. 
 
 
 ## Configuration
+### docker-compose.yml
+```
+services:
+  photonglass:
+    container_name: photonglass
+    restart: unless-stopped
+    build: .
+    ports:
+      - 5000:5000
+    volumes:
+      - ./instance:/instance
+#      - ./instance/images:/app/static/images # Commented out by default to use default logos
+```
+
 ### instance/config.yaml
 ```
 header:
@@ -32,7 +47,6 @@ footer:
   text: "photonglass"
   peeringdb_href: "https://www.peeringdb.com"
   github_href: "https://github.com/alimickey"
-
 ```
 
 ### instance/commands.yaml
@@ -81,4 +95,4 @@ footer:
 
 
 ## Attribution
-This project was inspired by hyperglass after having difficulty deploying it. This project is not meant as a 1:1 replacement with hyperglass and as such is kept simple by design. At time of release only linux servers were tested as a target device, the same device library as hyperglass is used (netmiko) so compatibility with more devices should not be an issue, just be aware it is untested.
\ No newline at end of file
+This project was inspired by [hyperglass](https://hyperglass.dev/) after having difficulty deploying it. This project is not meant as a 1:1 replacement with hyperglass and as such is kept simple by design. At time of release only linux servers were tested as a target device, the same device library as hyperglass is used (netmiko) so compatibility with more devices should not be an issue, just be aware it is untested.
\ No newline at end of file
diff --git a/docker-compose.yml b/docker-compose.yml
deleted file mode 100644
index 306eb0f..0000000
--- a/docker-compose.yml
+++ /dev/null
@@ -1,10 +0,0 @@
-services:
-  photonglass:
-    container_name: photonglass
-    restart: unless-stopped
-    build: .
-    ports:
-      - 5000:5000
-    volumes:
-      - ./instance:/instance
-#      - ./instance/images:/app/static/images
\ No newline at end of file