Refs #204 Adding templates (#205)

* Refs #204 Adding templates * Refs #204 Adding templates * Refs #204 Adding templates * Refs #204 Starting paper. * Refs #204 Continuing paper draft. * Refs #204 Continuing paper draft. * Refs #204, added more ideas. * Refs #204, added more ideas. * Refs #204. Proposed summary for paper. * Refs #204 Continuing paper draft. * Refs #204, added more ideas. * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Added basic structure for API static doc * Refs #204, base documentation now in git repository, using sphinx * Changed swaggerdoc to openapi * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204. Updated API docs. * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204, base documentation now in git repository, using sphinx * Refs #204. Updated docs. * Refs #204 Almost working dev environment. * Refs #204. Updating Docker files. * Refs #204, Added configuration. * Refs #204 Update nginx config * Refs #204. Reorganized files and fixed wrong links in docs. * Refs #204. Updated docs. * Refs #204 Generating pdf from Windows. * Refs #204 Updated Babel that was broken after package update. * Refs #204 Updating docker configuration , some issues with nginx redirections. * Refs #204 Updated docker files to avoid problem with the creation of the environment. * Refs #204. Fixed nginx docker resolver for webrtc sessions. * Refs #204 Updated docker files to add ssh server. * Refs #204 Modified to run only ssh server. Need to connect to start server. * Refs #204 Simplified Dockerfiles with smaller images, adding remote debug capabilities with VS Code. Fixed translations. * Refs #204, remove Dockerfile, not used anymore. * Refs #204, Skeleton for Docker. In progress. * Refs #204, updated instructions. * Refs #204, fixed typo. * Refs #204, fix for Linux and older version of Docker * Refs #204, Updated to latest version. * Refs #204, updated paper with FM version. * Refs #204, updated paper with FM version. * Refs #204 updated authors * Refs #204 updated authors * Refs #204 updated authors * Removed .vscode folder. * Updated docs/conf.py version number. --------- Co-authored-by: Simon Briere <[email protected]>
introlab · Apr 19, 2023 · afea808 · afea808
1 parent 53fe459
commit afea808
Show file tree

Hide file tree

Showing 107 changed files with 12,652 additions and 373 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,38 @@
+The document is based on [this template](https://github.com/auth0/open-source-template/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
+
+By submitting a PR to this repository, you agree to the terms within the [Code of Conduct](https://github.com/introlab/opentera-webrtc/blob/main/CODE_OF_CONDUCT.md). 
+Please see the [contributing guidelines](https://github.com/introlab/opentera-webrtc/blob/main/CONTRIBUTING.md) for how to create and submit a high-quality PR for this repo.
+
+### Description
+
+> Describe the purpose of this PR along with any background information and the impacts of the proposed change. 
+> For the benefit of the community, please do not assume prior context.
+>
+> Provide details that support your chosen implementation, including: breaking changes, alternatives considered, changes to the API, etc.
+
+
+### References
+
+> Include any links supporting this change such as a:
+>
+> - GitHub Issue/PR number addressed or fixed
+> - Related pull requests/issues from other repos
+>
+> If there are no references, simply delete this section.
+
+### Testing
+
+> Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. 
+> Tests should be added for new functionality and existing tests should complete without errors.
+>
+> Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.
+
+- [ ] This change adds test coverage for new/changed/fixed functionality
+
+### Checklist
+
+- [ ] I have added documentation for new/changed functionality in this PR
+- [ ] I have formatted the files
+- [ ] All active GitHub checks for tests are passing
+- [ ] The correct base branch is being used, if not `main`
+
diff --git a/.github/workflows/draft-joss-paper-pdf.yml b/.github/workflows/draft-joss-paper-pdf.yml
@@ -0,0 +1,26 @@
+name: JOSS Paper Draft PDF
+
+on: [push]
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: joss-paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v3
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: joss-paper/paper.pdf
+
diff --git a/.github/workflows/gen-doc-and-deploy-to-github-pages.yml b/.github/workflows/gen-doc-and-deploy-to-github-pages.yml
@@ -0,0 +1,97 @@
+name: gen-doc-and-deploy-to-github-pages
+
+on:
+  push:
+    branches: [main, joss-paper-draft]
+  workflow_dispatch:
+    branches: [main, joss-paper-draft]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.10.7]
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: recursive
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install System Dependencies
+      run: |
+        sudo apt-get install cmake protobuf-compiler wget curl redis-server postgresql nginx
+
+    - name: Run System Services
+      run: |
+        sudo systemctl enable postgresql
+        sudo systemctl start postgresql
+
+    - name: Create Database Tables
+      run: |
+        sudo -u postgres psql -c "ALTER USER postgres WITH PASSWORD 'opentera';"
+        sudo -u postgres psql -c "create database opentera;"
+        sudo -u postgres psql -c "create user TeraAgent with encrypted password 'tera';"
+        sudo -u postgres psql -c "grant all privileges on database opentera to TeraAgent;"
+        sudo -u postgres psql -c "ALTER USER TeraAgent WITH PASSWORD 'tera';"
+        sudo -u postgres psql -c "create database openteralogs;"
+        sudo -u postgres psql -c "grant all privileges on database openteralogs to TeraAgent;"
+        sudo -u postgres psql -c "create database openterafiles;"
+        sudo -u postgres psql -c "grant all privileges on database openterafiles to TeraAgent;"
+        sudo -u postgres psql -c "\l"
+
+    - name: Install Miniconda3
+      run: |
+        echo $HOME
+        wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
+        bash ./Miniconda3-latest-Linux-x86_64.sh -b -p $HOME/miniconda3
+
+    - name: Run CMake and build
+      working-directory: teraserver
+      run: |
+        cmake .
+        make python-all
+        echo "OPENTERA_PYTHON=$(echo $PWD/python/env/python-3.10/bin/python)" >> $GITHUB_ENV
+        echo "PYTHONPATH=$(echo $PWD/python)" >> $GITHUB_ENV
+
+    - name: Generate Self Signed TLS Certificates
+      working-directory: teraserver/python
+      run: |
+        $OPENTERA_PYTHON CreateCertificates.py
+
+    - name: Run NGINX Reverse Proxy
+      working-directory: teraserver/python/config
+      run: |
+        mkdir logs
+        ./start_nginx.sh
+
+    - name: Start TeraServer With Tests Enabled
+      working-directory: teraserver/python
+      run: |
+        $OPENTERA_PYTHON TeraServer.py --enable_tests=1 &
+        sleep 10
+
+    - name: Generate base documentation
+      working-directory: docs
+      run: |
+        pip install -r requirements.txt
+        make html
+        touch _build/html/.nojekyll
+
+    - name: Update API json documentation
+      working-directory: docs/services/teraserver/api
+      run: |
+        curl -O --insecure https://localhost:40075/api/swagger.json
+
+    - name: Deploy to GitHub Pages
+      uses: JamesIves/[email protected]
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: gh-pages
+        folder: docs/_build/html
+
diff --git a/.gitignore b/.gitignore
@@ -88,3 +88,6 @@ build-teraserver-Desktop_Qt_5_15_2_MSVC2019_64bit-Debug
 python-3.10
 /teraserver/easyrtc/package-lock.json
 venv
+joss-paper/paper.jats
+joss-paper/paper.pdf
+/.vscode
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.