Skip to content

Commit

Permalink
Update: just-the-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanmccartney committed Nov 30, 2023
1 parent 07ddb19 commit d7ea427
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 252 deletions.
6 changes: 4 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
remote_theme: pmarsceill/just-the-docs
remote_theme: just-the-docs/just-the-docs
title: BBC BUG
logo: "/assets/images/logo.png"
color_scheme: dark
color_scheme: bug
description: Broadcast Universal Gateway
show_downloads: true
footer_content: "BUG was created in <a href="https://bbc.co.uk/news">BBC News</a>, by <a href="https://github.com/geoffhouse">Geoff House</a> and <a href="https://github.com/ryanmccartney">Ryan McCartney</a>."

10 changes: 0 additions & 10 deletions docs/_includes/head-custom-google-analytics.html

This file was deleted.

9 changes: 0 additions & 9 deletions docs/_includes/head-custom.html

This file was deleted.

204 changes: 0 additions & 204 deletions docs/_layouts/default.html

This file was deleted.

5 changes: 0 additions & 5 deletions docs/_layouts/home.html

This file was deleted.

5 changes: 0 additions & 5 deletions docs/_layouts/page.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_layouts/table_wrappers.html

This file was deleted.

Empty file.
4 changes: 2 additions & 2 deletions docs/pages/development/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ For development on your local machine with docker (recommended)
1. Change directory to the `./src/client` folder.
1. Run `npm i --legacy-peer-deps` to install all the frontend dependencies locally.
1. Change directory to the root folder of the repository. This will be the same level as the `docker-compose.yml` file in the repository.
1. Spin up your development instance with `docker-compose up -d`. It may take around 5 minutes for the development build of the frontend react app to become available. You can view the live logs from the main BUG contrainer `bug` using the command `docker logs --tail 1000 -f bug`.
1. Spin up your development instance with `docker-compose up -d`. It may take around 5 minutes for the development build of the frontend react app to become available. You can view the live logs from the main BUG container `bug` using the command `docker logs --tail 1000 -f bug`.
1. Get developing. If you're using the default ports, the web interface will be available on port 3000, the API on port 3101 and the GUI view of the MongoDB database on port 3202.

You can change many of the port parameters and logging locations by setting environment variables in the `docker-compose.yml` file in the root directory.
Expand All @@ -41,5 +41,5 @@ Microsoft's [Visual Studio Code](https://code.visualstudio.com/) has been used f
- If you experience errors during the `npm i` process using `npm i --legacy-peer-deps` may help.
- The `-d` in the command `docker compose -d` deataches the process from the terminal running the container in the background.
- If you're getting Docker related 'permission denied' errors, make sure you've run the Docker [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/) on Linux.
- If you're developing on a linux OS you may see errors on the main bug container logs regarding file write persmission. This can be solved by giving the docker group read write permissions on the respository directory.
- If you're developing on a linux OS you may see errors on the main bug container logs regarding file write permission. This can be solved by giving the docker group read write permissions on the repository directory.
- If using a linux machine for development it's suggested that [docker engine](https://docs.docker.com/engine/install/ubuntu/) is used rather than docker desktop.
8 changes: 4 additions & 4 deletions docs/pages/installation/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ The BUG image itself is around 300MB. You'll need 2GB of storage space free on y

BUG itself requires 1GB of free RAM. Each container uses around of 100MB of RAM, you should budget accordingly.

Some modules, have higher memory requirements. For exmapled the Cisco-SG module which requires 250MB. When this is the cause it is defined as an optional feild `memory` in the `module.json` definition file. This additonal memory requirement is down to the number of workers these modules run. Each additional worker requires approximately 10MB of memory.
Some modules, have higher memory requirements. For exmapled the Cisco-SG module which requires 250MB. When this is the cause it is defined as an optional field `memory` in the `module.json` definition file. This additional memory requirement is down to the number of workers these modules run. Each additional worker requires approximately 10MB of memory.

Note - If you're building a development build of BUG you'll require at least 4GB of RAM in order to `create-react-app` to complie the development build.
Note - If you're building a development build of BUG you'll require at least 4GB of RAM in order to `create-react-app` to compile the development build.

## CPU

### Archictecture
### Architecture

Currently BUG runs on x64 CPU architectures only. In future support may be extened to ARMv7 for Raspberry Pi.
Currently BUG runs on x64 CPU architectures only. In future support may be extended to ARMv7 for Raspberry Pi.
2 changes: 1 addition & 1 deletion docs/pages/installation/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ A: Check the `port` for the `bug-app` when you type in `docker ps` to the termin

## Q: I'm trying to run a totally fresh install of BUG

A: The following docker commands may help, although use with caution. `docker kill $(docker ps -q)`, kills all running containers on your system. `docker rm $(docker ps -a -q)` removes these containers. `docker rmi $(docker images -q)` removes all images on your host syste,s
A: The following docker commands may help, although use with caution. `docker kill $(docker ps -q)`, kills all running containers on your system. `docker rm $(docker ps -a -q)` removes these containers. `docker rmi $(docker images -q)` removes all images on your host system
4 changes: 2 additions & 2 deletions docs/pages/modules/exterity.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 12

# Exterity STB

Channel list server and device manger for exterity STBs
Channel list server and device manager for exterity STBs

![Exterity STB Module Screenshot](/bug/assets/images/screenshots/module-exterity.png)

Expand All @@ -22,7 +22,7 @@ Add a channel list using multicast address and then add exterity devices. Channe
"needsConfigured": false,
"title": "",
"module": "exterity",
"description": "Channel list server and device manger for exterity STBs",
"description": "Channel list server and device manager for exterity STBs",
"enabled": false,
"channels": {},
"devices": {}
Expand Down
7 changes: 6 additions & 1 deletion docs/pages/security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ has_children: true

# Security

BUG provides a number of authentication methods for security. Under the hood these use `passport.js`. It is not recommended that you would ever expose a instance of BUG to the internet directly. Security is provided to prevent mishaps, accidental switching or unauthorized control of equipment.
{: .important-title }
> Notice
>
> It is not recommended to expose BUG directly on the internet.
BUG provides a number of authentication methods for security. Under the hood these use `passport.js`. It is not recommended that you would ever expose an instance of BUG to the internet directly. Security is provided to prevent mishaps, accidental switching or unauthorized control of equipment.

You can access the security menu from `/system/security`.

Expand Down

0 comments on commit d7ea427

Please sign in to comment.