diff --git a/docs/how-to-cite.md b/docs/how-to-cite.md new file mode 100644 index 0000000000000000000000000000000000000000..db6680401615199c0a6d1aef3cd60c5beb9cb610 --- /dev/null +++ b/docs/how-to-cite.md @@ -0,0 +1,7 @@ +When referencing the INJECT Exercise Platform, please cite our paper titled: + +[**From Paper to Platform: Evolution of a Novel Learning Environment for Tabletop Exercises**](https://www.muni.cz/en/research/publications/2390899) + +This paper provides insights and practical experiences derived from a cybersecurity course where tabletop exercises were introduced utilizing the innovative technology of the INJECT Exercise Platform (IXP). + +For a comprehensive overview of tabletop exercises, we recommend our Systematic Literature Review: ["Research and Practice of Delivering Tabletop Exercises."](https://www.muni.cz/en/research/publications/2390898) diff --git a/docs/tech/example_csv.csv b/docs/tech/example_csv.csv new file mode 100644 index 0000000000000000000000000000000000000000..18b01446ef4d2d193957771970945b41f75b4823 --- /dev/null +++ b/docs/tech/example_csv.csv @@ -0,0 +1,4 @@ +username,group,tags,first_name,last_name +john@email.cz,instructor,first,John,Doe +john1@email.cz,trainee,first,John Second,Doe +john2@email.cz,admin,first,John Third,Doe diff --git a/docs/tech/installation.md b/docs/tech/installation.md index 3b9039a84cc71bf0974ffe0e347369fd2a7872c6..dcad221d1018d6905a259ca5728673583205a603 100644 --- a/docs/tech/installation.md +++ b/docs/tech/installation.md @@ -4,9 +4,24 @@ The INJECT Exercise Platform comprises two main components: the frontend and the For a deeper understanding of the overall architecture of the INJECT Exercise Platform, you can refer to the [architecture overview](architecture/overview.md) in the documentation. -## Hardware Requirements +## Prerequisites +### Hardware Requirements + +Before you begin, ensure that you have the following: + +* A server with at least 1 core CPU and 4 GB RAM +* A 64-bit x86 architecture +* Root or sudo access to the server + +These requirements ensure that the backend server can handle data processing efficiently while serving the frontend interface smoothly. +### Software Requirements + +* Operating System: Debian (recommended) +* [Docker](https://www.docker.com/) +* [Docker Compose](https://docs.docker.com/compose/) + +Make sure to install Docker and Docker Compose before proceeding with the installation. -Before you begin, ensure that you have the following: a server with at least 2 core CPU and 4GB RAM, a 64-bit x86 architecture and root or sudo access to the server. This ensures that the backend server can handle data processing efficiently while serving the frontend interface smoothly. The installation files for deployment are zipped and available on GitLab. You can download them from [here](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/main/files-from-repos/deployment-files.zip?ref_type=heads&inline=false) diff --git a/docs/tech/security.md b/docs/tech/security.md index bc203e7cc731b631b9fa681e7040c12cbb64001d..d366d93a9e34423d2280b78ee579829bd1596272 100644 --- a/docs/tech/security.md +++ b/docs/tech/security.md @@ -39,7 +39,7 @@ username,group,tags,first_name,last_name ``` - **username** (mandatory) - - has to be a valid email address of the user (he will receive credentials via this email) + - has to be a valid email address of the user (user will receive credentials via this email) - **group** (optional, implicitly "trainee") - authorization role of the created user - values: trainee, instructor, or admin (shorts "t", "i" or "a" can be used as well) case is ignored @@ -52,4 +52,5 @@ Instructors cannot create users with higher privileges. admin (admin can be crea - **last_name** (optional) - last name of the created user if you want to identify them later -As a separator for the column, you can use either `,` or `;`. \ No newline at end of file +As a separator for the column, you can use either `,` or `;`. +An example of such a file can be downloaded [here]() \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 4f3938b1539c5fe47b1c61d3cccac888e1489f64..c2ba7271770130ff4a21e315beeb81e7dba4c3a7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -31,6 +31,7 @@ nav: - Authors: authors.md - Report bugs: report-bugs.md - Acknowledgements: acknowledgements.md + - How to cite: how-to-cite.md # - License: license.md markdown_extensions: