fixes
This commit is contained in:
parent
fe24094f86
commit
3ed8b58c9d
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,6 +1,7 @@
|
||||
# Config files
|
||||
instance/*
|
||||
|
||||
docker-compose.yml
|
||||
|
||||
# Python
|
||||
app/__pycache__/
|
||||
|
26
README.md
26
README.md
@ -1,12 +1,13 @@
|
||||
# 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.
|
||||
- **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`
|
||||
@ -15,13 +16,27 @@ A modern, distributed looking glass application that provides network insight fo
|
||||
- `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
|
||||
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.
|
||||
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.
|
@ -1,10 +0,0 @@
|
||||
services:
|
||||
photonglass:
|
||||
container_name: photonglass
|
||||
restart: unless-stopped
|
||||
build: .
|
||||
ports:
|
||||
- 5000:5000
|
||||
volumes:
|
||||
- ./instance:/instance
|
||||
# - ./instance/images:/app/static/images
|
Loading…
x
Reference in New Issue
Block a user