Deprecation Warning!
====================

This documentation is deprecated
Please visit https://development.pages.sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/ for the most recent documentation!





Welcome to FileHook's documentation!
====================================

This document discusses the CodeAbility Sharing Platform's general infrastructure and the currently implemented GitLab file hooks to extend the GitLab functionality.

The primary idea of the CodeAbility Sharing Platform is to give lecturers an infrastructure where they can easily share and discuss learning materials like lab exercises, lecture slides, collections of links, or Artemis exercises.
After we evaluated the requirements using a survey, we could not find any existing system/platform that satisfies most of the requirements.
However, survey participants pointed out that they are using GitLab and GitHub to share exercises.
Since GitLab provides a well-known, established process to share resources and is open-source, we provided an initial version as a GitLab instance where resources can be shared with project partners in the group ``sharing``.
To incorporate a major missing features - metadata search - it is planned to add a new service on top of GitLab.
Among others, this new service should provide an appealing starting page for the Sharing Platform and an intuitive search interface to allow users to find relevant material easily.
The backend part of this service is described here. It comprises validation and indexing of valid repositories.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   infrastructure
   filehooks_infrastructure
   modules
   git_search


Servers
=======

Currently, two servers are used for the CodeAbility Sharing Platform.
For logging into the servers via ``ssh``, you have to be in the university network!

+-------------+----------------+--------------------------------------------------------+
| Type        | Server-IP      | Hostname(s)                                            |
+=============+================+========================================================+
| Production  | 138.232.18.166 | - https://sharing-codeability.uibk.ac.at/              |
|             |                | - http://search.sharing-codeability.uibk.ac.at/        |
+-------------+----------------+--------------------------------------------------------+
| Development | 138.232.18.162 | - https://sharing.codeability-austria.uibk.ac.at/      |
|             |                | - https://dev-exchange.codeability-austria.uibk.ac.at/ |
+-------------+----------------+--------------------------------------------------------+


Production Server
-----------------

- CPU: 2 Cores
- RAM: 16 GB
- HDD: 10 GB (System) [+ 100 GB data @ /mnt/qt-sharing-codeability]
- OS: Debian 10

Development Server
------------------

- CPU: 4 Cores
- RAM: 16 GB
- HDD: 10 GB (System) [+ 100 GB data @ /qt-sharing-codeability]
- OS: Debian 10

.. note::

    The development server is shared with other development services (e.g., Artemis).



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`