diff --git a/Documentation/.idea/workspace.xml b/Documentation/.idea/workspace.xml deleted file mode 100644 index 9c81c86..0000000 --- a/Documentation/.idea/workspace.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Documentation/cd.tree b/Documentation/cd.tree deleted file mode 100644 index c14f2f6..0000000 --- a/Documentation/cd.tree +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Documentation/cfg/buildprofiles.xml b/Documentation/cfg/buildprofiles.xml deleted file mode 100644 index ef85c9d..0000000 --- a/Documentation/cfg/buildprofiles.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - true - false - aqua - headerFullSize.png - headerFullSize.png - https://ciscapps.kioydiolabs.org/ - CISCAPPS - https://ciscapps.kioydiolabs.org - true - - - - - \ No newline at end of file diff --git a/Documentation/images/ciscoPhone.png b/Documentation/images/ciscoPhone.png deleted file mode 100644 index 5acf588..0000000 Binary files a/Documentation/images/ciscoPhone.png and /dev/null differ diff --git a/Documentation/images/editingXMLfile.png b/Documentation/images/editingXMLfile.png deleted file mode 100644 index 4735de3..0000000 Binary files a/Documentation/images/editingXMLfile.png and /dev/null differ diff --git a/Documentation/images/freePbx1.2.png b/Documentation/images/freePbx1.2.png deleted file mode 100644 index 07e78ce..0000000 Binary files a/Documentation/images/freePbx1.2.png and /dev/null differ diff --git a/Documentation/images/freePbx1.png b/Documentation/images/freePbx1.png deleted file mode 100644 index 186f096..0000000 Binary files a/Documentation/images/freePbx1.png and /dev/null differ diff --git a/Documentation/images/header.png b/Documentation/images/header.png deleted file mode 100644 index 3f54941..0000000 Binary files a/Documentation/images/header.png and /dev/null differ diff --git a/Documentation/redirection-rules.xml b/Documentation/redirection-rules.xml deleted file mode 100644 index d654232..0000000 --- a/Documentation/redirection-rules.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - Created after removal of "Section Starting Page" from CISCAPPS Documentation - Section-Starting-Page.html - - - Created after removal of "How to" from CISCAPPS Documentation - How-to.html - - - Created after removal of "Overview" from CISCAPPS Documentation - Overview.html - - - Created after removal of "Reference" from CISCAPPS Documentation - Reference.html - - - Created after removal of "Tutorial" from CISCAPPS Documentation - Tutorial.html - - - Created after removal of "Starter" from CISCAPPS Documentation - Starter.html - - - Created after removal of "Section Starting Page" from CISCAPPS Documentation - Section-Starting-Page.html - - \ No newline at end of file diff --git a/Documentation/topics/Deploy-CISCAPPS.md b/Documentation/topics/Deploy-CISCAPPS.md deleted file mode 100644 index d54d0b2..0000000 --- a/Documentation/topics/Deploy-CISCAPPS.md +++ /dev/null @@ -1,15 +0,0 @@ -# Deploy CISCAPPS - -You are now ready to deploy CISCAPPS. - -Run the command : -```Shell -sudo docker-compose up -d -``` - -The `-d` means that the container will run as a daemon in the background. - -This will pull the CISCAPPS image from Docker Hub and deploy it in a container. -It shouldn't take more than 5-10 minutes. - -Your CISCAPPS installation should now be accessible! You can test it out in a web browser. \ No newline at end of file diff --git a/Documentation/topics/Deskphone-Configuration.md b/Documentation/topics/Deskphone-Configuration.md deleted file mode 100644 index 1c4e3d9..0000000 --- a/Documentation/topics/Deskphone-Configuration.md +++ /dev/null @@ -1,14 +0,0 @@ -# Deskphone Configuration - -After you have installed CISCAPPS on your server, you need to configure -the deskphones to use it. - -**Depending on the system you use for managing the phones choose the appropriate guide.** -- [FreePBX (chan_sccp module)](freePbxChanSCCP.md) - - - -**You can also edit the XML configuration files directly. -[Edit the XML configuration files](XML-Files-Manual-Configuration.md)** - -_Note : Guide for CUCM (Cisco Unified Communications Manager) coming soon._ \ No newline at end of file diff --git a/Documentation/topics/Installation.md b/Documentation/topics/Installation.md deleted file mode 100644 index abc96ab..0000000 --- a/Documentation/topics/Installation.md +++ /dev/null @@ -1,9 +0,0 @@ -# Docker Installation - -Welcome to the CISCAPPS installation and configuration guide using Docker. - -**This document will guide you through :** -- Configuring CISCAPPS - - [Installing required packages](Installing-required-packages.md) - - [Modifying the configuration file](Modify-Configuration-File.md) - - [Deploying CISCAPPS on Docker](Deploy-CISCAPPS.md) \ No newline at end of file diff --git a/Documentation/topics/Installing-required-packages.md b/Documentation/topics/Installing-required-packages.md deleted file mode 100644 index 95f277f..0000000 --- a/Documentation/topics/Installing-required-packages.md +++ /dev/null @@ -1,22 +0,0 @@ -# Installing required packages - -### Step 1 : _Updating the repositories_ - -Update the package repositories - -```Shell -sudo apt update -``` - -### Step 2 : _Install required packages_ - -_Note : You need to be a **sudo** user (administrator privileges), unless you are **root**._ - -Install **docker.io** and **docker-compose**. \ -The `-y` automatically confirms the installation. - -```Shell -sudo apt install docker.io docker-compose -y -``` - -This may take a few minutes. \ No newline at end of file diff --git a/Documentation/topics/Introduction.md b/Documentation/topics/Introduction.md deleted file mode 100644 index 47050a3..0000000 --- a/Documentation/topics/Introduction.md +++ /dev/null @@ -1,15 +0,0 @@ -# Introduction - -## What's CISCAPPS? -In 2009 Cisco released the 79XX IP deskphone series, which could be configured to access XML applications. -Those were applications coded in a proprietary XML format that the phones could read. \ -\ -Many software companies released apps for the phones at the time. -However, there are none available today. \ -\ -CISCAPPS, is a suite of XML apps developed for the 79XX deskhpones, such as a simple weather app or a rock, -paper, scissors anyone who has a 79XX deskphone and wants to experiment with it, -or even for businesses who still use them. - -## Configuring CISCAPPS -[Installation and configuration instructions](Installation.md) \ No newline at end of file diff --git a/Documentation/topics/Modify-Configuration-File.md b/Documentation/topics/Modify-Configuration-File.md deleted file mode 100644 index 8c05747..0000000 --- a/Documentation/topics/Modify-Configuration-File.md +++ /dev/null @@ -1,39 +0,0 @@ -# Modify Configuration File - -##### Step 1 : _Download the docker compose file_ - -Download the **docker-compose.yaml** file - -```Shell -wget https://raw.githubusercontent.com/kioydiolabs/ciscapps_suite/main/Docker/docker-compose.yaml -``` - -##### Step 2 : _Modify the docker compose file_ - -The **docker-compose.yaml** file looks like this : - -```yaml -version: '3' -services: - ciscapps: - image: sthivaios/ciscapps:latest - environment: - fullHostname: "" # full hostname with http/https here. eg. : https://ciscapps.com or http://192.168.1.150 - hostname: "" # the ip or domain of the server - alphavantageKey: "XXXXXXXXXX" # your AlphaVantage API key - serverPort: "80" - ports: - - 80:80 -``` - -1) Edit the `fullHostname` variable so that it begins with `http://` or `https://`. This can either be an IP address or a domain. - Example : `https://ciscapps.com` or `http://192.168.1.100` -2) Edit the `hostname` variable to the domain or IP address of the server **without** `http://` or `https://` in front. - Example : `ciscapps.com` or `192.168.1.100` -3) Edit the `alphavantageKey` variable to your AlphaVantageâ„¢ API key. You can get one from AlphaVantage's website. - If you don't want to use the stocks app, leave that as `XXXXXXXXXX` -4) If you wish to change the default port (port 80) change the `serverPort` variable to that port. Make sure to change - the port number in the `ports:` section too, but **don't** change the number 80 after the `:`. Example : to use port - 8056, set the ports to `8056:80` and change the `serverPort` variable to `8056`. - -**Make sure to save the file!** \ No newline at end of file diff --git a/Documentation/topics/XML-Files-Manual-Configuration.md b/Documentation/topics/XML-Files-Manual-Configuration.md deleted file mode 100644 index 6e5d5a9..0000000 --- a/Documentation/topics/XML-Files-Manual-Configuration.md +++ /dev/null @@ -1,19 +0,0 @@ -# XML Files (Manual) Configuration - -To configure the deskphones to access CISCAPPS, you can also edit the XML -configuration files. - -This guide assumes you know how to find the XML file(s). - -1) Locate the lines `` and `` -2) Edit the `informationURL` to your server's hostname followed by `/info/` -3) Edit the `servicesURL` to your server's hostname followed by `/homepage/` - ![editingXMLfile.png](editingXMLfile.png) -4) Save the file. -5) Manually restart the phone by unplugging the ethernet cable. - -The phone(s) should now be able to access CISCAPPS! You can try it out by pressing -the Services button on one of the phones. **_(Image below - Num.7)_** - -![ciscoPhone.png](ciscoPhone.png) -(from cisco.com) \ No newline at end of file diff --git a/Documentation/topics/freePbxChanSCCP.md b/Documentation/topics/freePbxChanSCCP.md deleted file mode 100644 index 8aef932..0000000 --- a/Documentation/topics/freePbxChanSCCP.md +++ /dev/null @@ -1,21 +0,0 @@ -# FreePBX (chan_sccp) Configuration - -Configuring FreePBX with CISCAPPS is actually quite easy. - -1) Login into your FreePBX admin panel. -2) Navigate to the **"Sccp Connectivity"** tab and select **"Server Config"** - ![freePbx1.png](freePbx1.png) -3) Then click on the **"SCCP Device URL"** tab. -4) Edit the **"Phone Service URL"** and the **"Phone information URL"** to your - server's hostname, followed by `/homepage/` for the Service URL and `/info/` - for the information URL. ![freePbx1.2.png](freePbx1.2.png) -5) Make sure to click Submit to save the changes. - -The phones should automatically pull the new configuration, but if they don't, -then you need to restart the phones manually by pulling the ethernet cable out. - -All phones should now be able to access CISCAPPS! You can try it out by pressing -the Services button on one of the phones. **_(Image below - Num.7)_** - -![ciscoPhone.png](ciscoPhone.png) -(from cisco.com) \ No newline at end of file diff --git a/Documentation/writerside.cfg b/Documentation/writerside.cfg deleted file mode 100644 index d602543..0000000 --- a/Documentation/writerside.cfg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/deploy.md b/deploy.md index ae5f0e2..c3fbbbc 100644 --- a/deploy.md +++ b/deploy.md @@ -1,3 +1,7 @@ +> [!CAUTION] +> **This guide is no longer being maintained. For the latest updated CISCAPPS documentation visit [https://ciscapps.kioydiolabs.org](https://ciscapps.kioydiolabs.org).** + + ## How to configure CISCAPPS Configuring CISCAPPS is really simple. Just use the **Docker Compose** to pull the image from **Docker Hub** and deploy a container.