Skip to content

Commit

Permalink
Merge branch 'main-ra'
Browse files Browse the repository at this point in the history
# Conflicts:
#	docs/docs/Installation/Linux/1.Installation.md
  • Loading branch information
RadioAndrea committed Dec 14, 2023
2 parents 54ad939 + 509d962 commit fa26a81
Showing 1 changed file with 46 additions and 22 deletions.
68 changes: 46 additions & 22 deletions docs/docs/Installation/Linux/1.Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ sudo apt update && sudo apt upgrade

<details>
<summary>
RHEL
Centos/RHEL/Fedora
</summary>

```bash
Expand All @@ -46,12 +46,14 @@ sudo dnf update
---
## 2. Pre-requisite Software


Install packages from the distro repo
<details>
<summary>
Ubuntu
</summary>

Install packages from the distro repo


```bash
sudo apt update && sudo apt install python3 && sudo apt install python3-pip
Expand All @@ -61,13 +63,29 @@ sudo apt install python3-dev python3-setuptools build-essential python3-gevent p

<details>
<summary>
RHEL
RHEL/Centos
</summary>

Install distro repo packages
```bash
sudo dnf group install "Development Tools"
sudo dnf install python3 pip virtualenv virtualenvwrapper cairo cairo-devel python3-gevent python3-lxml bzip2-devel libffi-devel
```

Create and activate a virtualenv for the next steps

```bash
virtualenv venv
source venv/bin/activate
```
</details>

<details>
<summary>
Fedora
</summary>

```bash
sudo dnf group install "C Development Tools and Libraries" "Development Tools"
sudo dnf group install "Development Tools" "C Development Tools and Libraries"
sudo dnf install python3 python3-pip cairo cairo-devel python3-cairo python3-cairo-devel python3-gevent python3-lxml python3-virtualenv
```

Expand All @@ -79,7 +97,6 @@ source venv/bin/activate
```
</details>


---
## 3. Install Python Libraries

Expand All @@ -98,7 +115,7 @@ Note, use of pip with sudo is not recommended and you will be warned about this!

<details>
<summary>
RHEL
Centos/RHEL/Fedora
</summary>


Expand All @@ -124,26 +141,32 @@ Ubuntu
sudo pip3 uninstall FreeTAKServer
sudo pip3 uninstall FreeTAKServer-UI
```

Delete the database and log folders

```bash
sudo rm /opt/FTSDataBase.db
sudo rm -r /usr/local/lib/<your-python-version>/<dist or site>-packages/FreeTAKServer
```
</details>

<details>
<summary>
RHEL
Centos/RHEL/Fedora
</summary>

```bash
deactivate
rm -rf venv/
pip uninstall FreeTAKServer FreeTAKServer-UI
```
</details>

Delete the database and log folders

```bash
sudo rm /opt/FTSDataBase.db
sudo rm -r /usr/local/lib/<your-python-version>/<dist or site>-packages/FreeTAKServer
sudo rm /opt/FTS/FTSDataBase.db
```
</details>

---
## 5. Install FreeTAKServer
Expand All @@ -161,7 +184,7 @@ sudo python3 -m pip install FreeTAKServer[ui]

<details>
<summary>
RHEL
Centos/RHEL/Fedora
</summary>

```bash
Expand Down Expand Up @@ -230,7 +253,7 @@ sudo python3 -m FreeTAKServer.controllers.services.FTS

<details>
<summary>
RHEL
Centos/RHEL/Fedora
</summary>

```bash
Expand All @@ -254,7 +277,7 @@ to automatically use the default.

An example is provided below, your exact configuration will differ.

```text
```css
would you like to use a yaml config file,
if yes you will be prompted for further configuration options [yes]:
where would you like to save the yaml config [/opt/fts/FTSConfig.yaml]:
Expand All @@ -263,6 +286,7 @@ enter the preferred database type (MySQL is highly experimental if you're not su
enter the preferred database path [/opt/fts/FTSDataBase.db]:
enter the preferred main path [/usr/local/lib/python3.11/site-packages/FreeTAKServer]:
enter the preferred log file path [/opt/fts/Logs]:

```

> :memo: **Note:** The IP in this configuration wizard is the FTS_MAIN_IP.
Expand Down Expand Up @@ -345,8 +369,8 @@ Advanced users may wish to use a different port.


```python
# Port the UI uses to communicate with the API
PORT = '19023'
# Port the UI uses to communicate with the API
PORT = '19023'
```

### Custom Secrets Configuration
Expand All @@ -355,7 +379,7 @@ The following items can be updated to use your own secrets, however the values
must be updated in both the `FreeTAKServer-UI/config.py` and the
`FreeTAKServer/core/configuration/MainConfig.py` files.

The API key used by the UI to communicate with FTS.
The API key used by the UI to comunicate with FTS.
Generate a new system user and then set it.
~~What does this mean? Where is a user generated? What is a system user?~~

Expand Down Expand Up @@ -409,7 +433,7 @@ sudo python3 run.py

<details>
<summary>
RHEL
Centos/RHEL/Fedora
</summary>

```bash
Expand All @@ -420,7 +444,7 @@ python run.py
You will see the UI server start up in your terminal, which should look similar
to that shown below.

```log
```python
(55501) wsgi starting up on http://0.0.0.0:5000
(55501) accepted ('192.168.1.100', 49842)
```
Expand Down Expand Up @@ -448,8 +472,8 @@ sudo pip install eventlet
The config file will also need to be updated.

```python
IP = ['FTS external IP']
APPIP = ['FTS-UI internal IP']
IP = [FTS external IP]
APPIP = [FTS-UI internal IP]
```

## 12. Check Installation
Expand Down Expand Up @@ -501,7 +525,7 @@ for TCP traffic.

<details>
<summary>
RHEL
Centos/RHEL/Fedora
</summary>

```bash
Expand Down

0 comments on commit fa26a81

Please sign in to comment.