diff --git a/Pipfile b/Pipfile deleted file mode 100644 index 99a37a995e082099890be9008e0514594803fbdc..0000000000000000000000000000000000000000 --- a/Pipfile +++ /dev/null @@ -1,12 +0,0 @@ -[[source]] -name = "pypi" -url = "https://pypi.org/simple" -verify_ssl = true - -[dev-packages] - -[packages] -mkdocs = "*" - -[requires] -python_version = "3.8" diff --git a/Pipfile.lock b/Pipfile.lock deleted file mode 100644 index 946af68e0519c192457e84bc3d7cf482a755eecb..0000000000000000000000000000000000000000 --- a/Pipfile.lock +++ /dev/null @@ -1,202 +0,0 @@ -{ - "_meta": { - "hash": { - "sha256": "24f503d79d3c2f8b16669eafeadee3fa2d6ab4a91ddfe070d7540fc684945fff" - }, - "pipfile-spec": 6, - "requires": { - "python_version": "3.8" - }, - "sources": [ - { - "name": "pypi", - "url": "https://pypi.org/simple", - "verify_ssl": true - } - ] - }, - "default": { - "click": { - "hashes": [ - "sha256:d2b5255c7c6349bc1bd1e59e08cd12acbbd63ce649f2588755783aa94dfb6b1a", - "sha256:dacca89f4bfadd5de3d7489b7c8a566eee0d3676333fbb50030263894c38c0dc" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", - "version": "==7.1.2" - }, - "future": { - "hashes": [ - "sha256:b1bead90b70cf6ec3f0710ae53a525360fa360d306a86583adc6bf83a4db537d" - ], - "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==0.18.2" - }, - "jinja2": { - "hashes": [ - "sha256:89aab215427ef59c34ad58735269eb58b1a5808103067f7bb9d5836c651b3bb0", - "sha256:f0a4641d3cf955324a89c04f3d94663aa4d638abe8f733ecd3582848e1c37035" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", - "version": "==2.11.2" - }, - "joblib": { - "hashes": [ - "sha256:698c311779f347cf6b7e6b8a39bb682277b8ee4aba8cf9507bc0cf4cd4737b72", - "sha256:9e284edd6be6b71883a63c9b7f124738a3c16195513ad940eae7e3438de885d5" - ], - "markers": "python_version >= '3.6'", - "version": "==0.17.0" - }, - "livereload": { - "hashes": [ - "sha256:776f2f865e59fde56490a56bcc6773b6917366bce0c267c60ee8aaf1a0959869" - ], - "version": "==2.6.3" - }, - "lunr": { - "extras": [ - "languages" - ], - "hashes": [ - "sha256:aab3f489c4d4fab4c1294a257a30fec397db56f0a50273218ccc3efdbf01d6ca", - "sha256:c4fb063b98eff775dd638b3df380008ae85e6cb1d1a24d1cd81a10ef6391c26e" - ], - "version": "==0.5.8" - }, - "markdown": { - "hashes": [ - "sha256:1fafe3f1ecabfb514a5285fca634a53c1b32a81cb0feb154264d55bf2ff22c17", - "sha256:c467cd6233885534bf0fe96e62e3cf46cfc1605112356c4f9981512b8174de59" - ], - "markers": "python_version >= '3.5'", - "version": "==3.2.2" - }, - "markupsafe": { - "hashes": [ - "sha256:00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473", - "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161", - "sha256:09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235", - "sha256:1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5", - "sha256:13d3144e1e340870b25e7b10b98d779608c02016d5184cfb9927a9f10c689f42", - "sha256:24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff", - "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b", - "sha256:43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1", - "sha256:46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e", - "sha256:500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183", - "sha256:535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66", - "sha256:596510de112c685489095da617b5bcbbac7dd6384aeebeda4df6025d0256a81b", - "sha256:62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1", - "sha256:6788b695d50a51edb699cb55e35487e430fa21f1ed838122d722e0ff0ac5ba15", - "sha256:6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1", - "sha256:717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e", - "sha256:79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b", - "sha256:7c1699dfe0cf8ff607dbdcc1e9b9af1755371f92a68f706051cc8c37d447c905", - "sha256:88e5fcfb52ee7b911e8bb6d6aa2fd21fbecc674eadd44118a9cc3863f938e735", - "sha256:8defac2f2ccd6805ebf65f5eeb132adcf2ab57aa11fdf4c0dd5169a004710e7d", - "sha256:98c7086708b163d425c67c7a91bad6e466bb99d797aa64f965e9d25c12111a5e", - "sha256:9add70b36c5666a2ed02b43b335fe19002ee5235efd4b8a89bfcf9005bebac0d", - "sha256:9bf40443012702a1d2070043cb6291650a0841ece432556f784f004937f0f32c", - "sha256:ade5e387d2ad0d7ebf59146cc00c8044acbd863725f887353a10df825fc8ae21", - "sha256:b00c1de48212e4cc9603895652c5c410df699856a2853135b3967591e4beebc2", - "sha256:b1282f8c00509d99fef04d8ba936b156d419be841854fe901d8ae224c59f0be5", - "sha256:b2051432115498d3562c084a49bba65d97cf251f5a331c64a12ee7e04dacc51b", - "sha256:ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6", - "sha256:c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f", - "sha256:cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f", - "sha256:cdb132fc825c38e1aeec2c8aa9338310d29d337bebbd7baa06889d09a60a1fa2", - "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7", - "sha256:e8313f01ba26fbbe36c7be1966a7b7424942f670f38e666995b88d012765b9be" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==1.1.1" - }, - "mkdocs": { - "hashes": [ - "sha256:096f52ff52c02c7e90332d2e53da862fde5c062086e1b5356a6e392d5d60f5e9", - "sha256:f0b61e5402b99d7789efa032c7a74c90a20220a9c81749da06dbfbcbd52ffb39" - ], - "index": "pypi", - "version": "==1.1.2" - }, - "nltk": { - "hashes": [ - "sha256:845365449cd8c5f9731f7cb9f8bd6fd0767553b9d53af9eb1b3abf7700936b35" - ], - "version": "==3.5" - }, - "pyyaml": { - "hashes": [ - "sha256:06a0d7ba600ce0b2d2fe2e78453a470b5a6e000a985dd4a4e54e436cc36b0e97", - "sha256:240097ff019d7c70a4922b6869d8a86407758333f02203e0fc6ff79c5dcede76", - "sha256:4f4b913ca1a7319b33cfb1369e91e50354d6f07a135f3b901aca02aa95940bd2", - "sha256:69f00dca373f240f842b2931fb2c7e14ddbacd1397d57157a9b005a6a9942648", - "sha256:73f099454b799e05e5ab51423c7bcf361c58d3206fa7b0d555426b1f4d9a3eaf", - "sha256:74809a57b329d6cc0fdccee6318f44b9b8649961fa73144a98735b0aaf029f1f", - "sha256:7739fc0fa8205b3ee8808aea45e968bc90082c10aef6ea95e855e10abf4a37b2", - "sha256:95f71d2af0ff4227885f7a6605c37fd53d3a106fcab511b8860ecca9fcf400ee", - "sha256:b8eac752c5e14d3eca0e6dd9199cd627518cb5ec06add0de9d32baeee6fe645d", - "sha256:cc8955cfbfc7a115fa81d85284ee61147059a753344bc51098f3ccd69b0d7e0c", - "sha256:d13155f591e6fcc1ec3b30685d50bf0711574e2c0dfffd7644babf8b5102ca1a" - ], - "version": "==5.3.1" - }, - "regex": { - "hashes": [ - "sha256:088afc8c63e7bd187a3c70a94b9e50ab3f17e1d3f52a32750b5b77dbe99ef5ef", - "sha256:1fe0a41437bbd06063aa184c34804efa886bcc128222e9916310c92cd54c3b4c", - "sha256:41bb65f54bba392643557e617316d0d899ed5b4946dccee1cb6696152b29844b", - "sha256:4318d56bccfe7d43e5addb272406ade7a2274da4b70eb15922a071c58ab0108c", - "sha256:4707f3695b34335afdfb09be3802c87fa0bc27030471dbc082f815f23688bc63", - "sha256:5533a959a1748a5c042a6da71fe9267a908e21eded7a4f373efd23a2cbdb0ecc", - "sha256:5f18875ac23d9aa2f060838e8b79093e8bb2313dbaaa9f54c6d8e52a5df097be", - "sha256:60b0e9e6dc45683e569ec37c55ac20c582973841927a85f2d8a7d20ee80216ab", - "sha256:84e9407db1b2eb368b7ecc283121b5e592c9aaedbe8c78b1a2f1102eb2e21d19", - "sha256:8d69cef61fa50c8133382e61fd97439de1ae623fe943578e477e76a9d9471637", - "sha256:9a02d0ae31d35e1ec12a4ea4d4cca990800f66a917d0fb997b20fbc13f5321fc", - "sha256:9bc13e0d20b97ffb07821aa3e113f9998e84994fe4d159ffa3d3a9d1b805043b", - "sha256:a6f32aea4260dfe0e55dc9733ea162ea38f0ea86aa7d0f77b15beac5bf7b369d", - "sha256:ae91972f8ac958039920ef6e8769277c084971a142ce2b660691793ae44aae6b", - "sha256:c570f6fa14b9c4c8a4924aaad354652366577b4f98213cf76305067144f7b100", - "sha256:d23a18037313714fb3bb5a94434d3151ee4300bae631894b1ac08111abeaa4a3", - "sha256:eaf548d117b6737df379fdd53bdde4f08870e66d7ea653e230477f071f861121", - "sha256:ebbe29186a3d9b0c591e71b7393f1ae08c83cb2d8e517d2a822b8f7ec99dfd8b", - "sha256:eda4771e0ace7f67f58bc5b560e27fb20f32a148cbc993b0c3835970935c2707", - "sha256:f1b3afc574a3db3b25c89161059d857bd4909a1269b0b3cb3c904677c8c4a3f7", - "sha256:f2388013e68e750eaa16ccbea62d4130180c26abb1d8e5d584b9baf69672b30f" - ], - "version": "==2020.9.27" - }, - "six": { - "hashes": [ - "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259", - "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==1.15.0" - }, - "tornado": { - "hashes": [ - "sha256:0fe2d45ba43b00a41cd73f8be321a44936dc1aba233dee979f17a042b83eb6dc", - "sha256:22aed82c2ea340c3771e3babc5ef220272f6fd06b5108a53b4976d0d722bcd52", - "sha256:2c027eb2a393d964b22b5c154d1a23a5f8727db6fda837118a776b29e2b8ebc6", - "sha256:5217e601700f24e966ddab689f90b7ea4bd91ff3357c3600fa1045e26d68e55d", - "sha256:5618f72e947533832cbc3dec54e1dffc1747a5cb17d1fd91577ed14fa0dc081b", - "sha256:5f6a07e62e799be5d2330e68d808c8ac41d4a259b9cea61da4101b83cb5dc673", - "sha256:c58d56003daf1b616336781b26d184023ea4af13ae143d9dda65e31e534940b9", - "sha256:c952975c8ba74f546ae6de2e226ab3cc3cc11ae47baf607459a6728585bb542a", - "sha256:c98232a3ac391f5faea6821b53db8db461157baa788f5d6222a193e9456e1740" - ], - "markers": "python_version >= '3.5'", - "version": "==6.0.4" - }, - "tqdm": { - "hashes": [ - "sha256:2dd75fdb764f673b8187643496fcfbeac38348015b665878e582b152f3391cdb", - "sha256:93b7a6a9129fce904f6df4cf3ae7ff431d779be681a95c3344c26f3e6c09abfa" - ], - "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==4.50.0" - } - }, - "develop": {} -} diff --git a/docs/accounts.md b/docs/accounts.md deleted file mode 100644 index 1d7201986695912ad8a3be648025526c0316c4cf..0000000000000000000000000000000000000000 --- a/docs/accounts.md +++ /dev/null @@ -1,35 +0,0 @@ -# Accounts - -Students at EPITA are given two kind of accounts: one is related with their -status as an IONIS student (Bocal Account), and another one is linked to EPITA -(CRI Account). - - -## Bocal - -The Bocal account is created at the beginning of the scholarship, allowing -students to: - - * Check one's emails on [Office365](https://login.microsoftonline.com/) - * Connect to Ionis Portal and IONIS (wifi) - * Connect to the [Bocal intranet](http://console.bocal.org) - - You can access this account with your `@epita.fr` email address. - -Your bocal password cannot be changed manually but it can be regenerated on the -[Bocal intranet](http://console.bocal.org/#/profile). - -## Epita - -Every EPITA student is given a CRI account. It serves purposes such as: - - * UNIX sessions on PXE - * UNIX exams (SPÉ/ING) - * CRI's intranet - * Assistants' intranets - * Moodle - * CRI's RocketChat - * Some workshops (THLR, algorithms, etc...) - - You access this account using your CRI `login` which is usually the first part - of your email address, before `@epita.fr`. diff --git a/docs/accounts/accounts.md b/docs/accounts/accounts.md new file mode 100644 index 0000000000000000000000000000000000000000..4166b2446ed5323040a38dcaded4193b9c4f80c9 --- /dev/null +++ b/docs/accounts/accounts.md @@ -0,0 +1,34 @@ +# Accounts + +Students at EPITA are given two kind of accounts: one is related with their +status as a IONIS student (Bocal Account), and another one is linked to EPITA +(CRI Account). + +## Bocal + +The Bocal account is created at the beginning of the scholarship, allowing +students to: + +* Check one's emails on [Office365](https://login.microsoftonline.com/) +* Connect to `Ionis Portal` and `IONIS` ([WiFi](/from_school/wifi/)) +* Connect to the [Bocal intranet](http://console.bocal.org) + +You can access this account with your `@epita.fr` email address. + +Your Bocal password cannot be changed manually but it can be regenerated on the +[Bocal intranet](http://console.bocal.org/#/profile). + +## EPITA + +Every EPITA student is given a CRI account. It serves purposes such as: + +* UNIX sessions on PXE +* UNIX exams (SPÉ/ING) +* CRI's intranet +* Assistants' intranets +* Moodle +* CRI's RocketChat +* Some workshops (THLR, algorithms, etc...) + + You access this account using your CRI `login` which is usually the first part + of your email address, before `@epita.fr`. diff --git a/docs/accounts/passwords.md b/docs/accounts/passwords.md new file mode 100644 index 0000000000000000000000000000000000000000..bc973a45c2f55cd29788f65da21b4072b0e7d39b --- /dev/null +++ b/docs/accounts/passwords.md @@ -0,0 +1,62 @@ +# Password update or recovery + +## Password update + +### Changing your CRI password + +It is possible to change the password to your [CRI Account](accounts.md). + +#### Password policy + +The password must be as follow: + +* At least 10 characters long +* Should have 3 different case (At least one uppercase character, one lower + case, and one numerical character) +* Not too similar to your other personal information. +* Different from a commonly used password. + +#### Procedure + +To change one's password, one has to go to the [CRI +intranet](https://cri.epita.fr/me). + +On your profile page (which you can access by clicking your login on the top +right corner of the page), click `Change password` and follow the procedure. + +### Changing your Bocal password + +Your Bocal password cannot be changed manually but it can be regenerated on the +[Bocal intranet](http://console.bocal.org). You can follow the [recovery +steps](#recovering-your-bocal-password) for the Bocal account. + +## Password recovery + +### Recovering your CRI password + +If you lost your CRI password, which is giving you access to the school's +computers, you can reset it following [this +link](https://cri.epita.fr/auth/password/recovery/). + +You will be asked for your login and an email will be sent to the `@epita.fr` +email address linked to your CRI account, with instructions and a reset link. + +You can also use the button `Instant recover with Office 365` which will use +your Bocal account to allow you to reset your password. This method is much +quicker. + +### Recovering your Bocal password + +If you lost your Bocal password, which is giving you access to your `@epita.fr` +email and WiFi, you have to submit a reset request following [this +link](https://console.bocal.org/#/recover). + +You will be asked your `@epita.fr` email, and a confirmation code will be sent +via SMS (or email if you own an international number). Once this code has been +entered, your new password will be sent to you via SMS (or, once again, email). +The messages can take a few minutes to arrive, be patient. + +If the phone number kept by the Bocal for password recovery is missing or wrong, +you **must** send a ticket at +[tickets@cri.epita.fr](mailto:tickets@cri.epita.fr) indicating your login and a +french phone number. diff --git a/docs/contact.md b/docs/contact.md deleted file mode 100644 index 7694571d6130a8932bdc672a91c92498437f7781..0000000000000000000000000000000000000000 --- a/docs/contact.md +++ /dev/null @@ -1,23 +0,0 @@ -# Contact - -In general, in case of any problem / incident / question, one should turn to his assistants and not directly to the Bocal or CRI. It is to the assistants responsibility to try solve any problem or to contact the CRI or the Bocal if needed. - -Any person contacting the Bocal without any justification might be punished. - -Any application towards assistants, the CRI or the Bocal must be as clear as possible, with a maximum of information. - -## Exceptions - -It is possible to contact the CRI directly in case of any particular need or suggestion regarding the IT workstation. If the requirement concerns a project, one has to contact his assistants. - -## Bocal - -To contact the Bocal, one has to create a ticket on their [jira](https://jira.ionis-it.com) instance. - -## CRI - -To contact the CRI, one has to create a ticket by sending a mail at [tickets@cri.epita.fr](mailto:tickets@cri.epita.fr). - -## Facebook - -Facebook is not a viable way of communication for the school! Any person trying to contact the CRI via Facebook will be punished. diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md new file mode 100644 index 0000000000000000000000000000000000000000..41db603a38a2083bf0fb67903af6cfc27008be02 --- /dev/null +++ b/docs/contributing/contributing.md @@ -0,0 +1,10 @@ +# Contributing + +Most of CRI's services are available as open source free software. This means +you can read the code that run some of our services and contribute to them. You +can find all of our open-source code on our [Gitlab +group](https://gitlab.cri.epita.fr/cri). + +Services developed by the CRI can be found under the "Services" subgroup. The +infrastructure written in "IaC" can be found in the "Infrastructure as Code" +subgroup. diff --git a/docs/doc_contributing.md b/docs/contributing/doc.md similarity index 94% rename from docs/doc_contributing.md rename to docs/contributing/doc.md index d3768781f9df546752caf7c2b394f7b829614ac0..92dd7ab7a70b8021aebcd2d6a9cc2b345fc7d42a 100644 --- a/docs/doc_contributing.md +++ b/docs/contributing/doc.md @@ -3,4 +3,4 @@ If you find an error on our documentation or find that a useful page is missing, please create an issue or a merge request on our [epita-doc](https://gitlab.cri.epita.fr/cri/documentation/epita-doc) GitLab -repository +repository. diff --git a/docs/map_contributing.md b/docs/contributing/map.md similarity index 99% rename from docs/map_contributing.md rename to docs/contributing/map.md index b121934a44f86619783c39f8deec50b906eb1956..c8d6de79da8e09e08a7a650d8371a449fc725296 100644 --- a/docs/map_contributing.md +++ b/docs/contributing/map.md @@ -1,4 +1,4 @@ -# Map +# SM Map ## What are SM Maps A map is a simple SVG file. This means that you can easily modify it to match diff --git a/docs/cri_vm.md b/docs/cri_vm.md deleted file mode 100644 index b1d05a55c080439737abd2002fded886b5869851..0000000000000000000000000000000000000000 --- a/docs/cri_vm.md +++ /dev/null @@ -1,293 +0,0 @@ -# How to setup and use the PIE VM - -!!! warning - No support is done by the CRI on the PIE VM. If you do not succeed in - making it work by your own means, you must work on the school computers. - -This method allow you to have the PIE environment running in a VM on your -computer. - -There exists two installation : Virtualbox and VMWare. Note that VirtualBox has -shown numerous bugs on MacOS. VMWare is thus recommended for MacOS users. - -## VirtualBox Installation - -### First step - -Install [Virtual Box](https://www.virtualbox.org/). - -On linux you can install it with your package manager -([Debian](https://wiki.debian.org/VirtualBox) or -[ArchLinux](https://wiki.archlinux.org/index.php/VirtualBox)). - -### Second step - -Download our [VirtualBox appliance](https://static.cri.epita.fr/cri-vm.ova). - -Open VirtualBox and go to `File > Import Appliance` and import the file you -just downloaded. - -![appliance](assets/vm_external_1.PNG) - -![import](assets/vm_external_2.PNG) - -![folder](assets/vm_external_3.PNG) - -When getting to the `Appliance settings` page, you may adjust the RAM and CPU -parameters. Be careful to have a least 2048 MB of RAM. - -You can then click the `Import` button. - -![settings](assets/vm_external_4.PNG) - - -### Third step - -Inside Virtual Box select your newly created virtual machine and click on -the `Start` button. - -![select](assets/vm_external_5.PNG) - -In the familiar PXE menu, choose the `Prepare disk` entry. - -Let it boot, a script will run automatically and your VM will shutdown once its -done. - -![menu](assets/vm_external_6.PNG) - - -### Fourth step - -You can now `Start` your VM again. You can now use the PXE menu as usual to -boot `Archlinux` image. - - -You can use the `skip-download` image to avoid downloading the image each time. -Be wary that this image may not be up to date and then have bugs. You should re-download -the VM every once in a while to be sure to have all the latest tools and potential bugs fixes. -You will find more information on this in the `cri.news` newsgroup. - - -!!! warning - Be careful ! You should log with `epita` user and no password. Your data is in - `/home/epita`, this directory is kept between reboot, you will not lose files - each time you stop your VM. - - -## VMWare Installation - -### First step - -Install VMWare Workstation : [VMWare Workstation](https://www.vmware.com/products/workstation-player/workstation-player-evaluation.html) -On Linux you can download it with your package manager -([Debian](https://wiki.debian.org/VMware) or [Archlinux](https://wiki.archlinux.org/index.php/VMware)). - -### Second step - -Download our [VMWare appliance](https://static.cri.epita.fr/vmware-cri-vm.zip). -Unzip the folder in an appropriate location (you can use `unzip vmware-cri-vm.zip`). - -Click on `Open a Virtual Machine`. - -![import](assets/vmware.png) - -Select the `CRI_VM` folder. -![import1](assets/import_vmware.png) - -Select the `CRI VM.vmx` file. -![import2](assets/import2_vmware.png) - -### Third step - -You now have an imported VM. You can now run it by double clicking on it. -![imported](assets/vmware_vm.png) - -In the familiar PXE menu, choose the `Prepare disk` entry. - -Let it boot, a script will run automatically and your VM will shutdown once its -done. - -![ipxemenu](assets/vmware_ipxe.png) - -### Fourth step - -You can now `Start` your VM again. You can now use the PXE menu as usual to -boot `Archlinux` image. - -You can use the `skip-download` image to avoid downloading the image each time. -Be wary that this image may not be up to date and then have bugs. You should re-download -the VM every once in a while to be sure to have all the latest tools and potential bugs fixes. -You will find more information on this in the `cri.news` newsgroup. - -!!! warning - Be careful ! You should log with `epita` user and no password. Your data is in - `/home/epita`, this directory is kept between reboot, you will not lose files - each time you stop your VM. - -## Mac VMWare Installation - -### First step - -For MacOS, install VMWare Fusion : [VMWare Fusion](https://www.vmware.com/go/downloadfusion). - -### Second step - -Download the iso file [ISO](https://static.cri.epita.fr/cri-vm.iso). - -Click on `Installer à partir du disque ou de l'image`. - -![import](assets/macos_install_1.png) - -Select the `cri-vm.iso` file. -![import1](assets/macos_install_2.png) - -Select Linux > Autre noyau Linux 5.x et version ultérieur 64 bits. -![import2](assets/macos_install_3.png) - -Select "BIOS hérité". -![import2](assets/macos_install_4.png) - -Click on "Terminer" and save the VM. -![import2](assets/macos_install_5.png) - -Before launching the VM, you need to edit the configuration. -Go to Machine Virtuelle > Paramètres. -![import2](assets/macos_configure_1.png) - -Then edit "Processeurs et mémoires". -![import2](assets/macos_configure_2.png) - -Put 4096 Mo (at least) of memory. If you can put more - if you have *enough* RAM -available. (Note that 4Go will probably be the maximum on a 8Go Mac). -![import2](assets/macos_configure_3.png) - -Go back to the previous menu and click "Disque Dur (SCSI)". -![import2](assets/macos_configure_2.png) - -Put (at least) 64 Go of disk space. Note that the disk format is optimized not to take -that much space on your disk. -![import2](assets/macos_configure_4.png) - - - -### Third step - -You now have an imported VM. You can now run it by double clicking on it. -![imported](assets/macos_launch.png) - -In the familiar PXE menu, choose the `Prepare disk` entry. - -Let it boot, a script will run automatically and your VM will shutdown once its -done. - -![ipxemenu](assets/vmware_ipxe.png) - -### Fourth step - -You can now `Start` your VM again. You can now use the PXE menu as usual to -boot `Archlinux` image. - -You can use the `skip-download` image to avoid downloading the image each time. -Be wary that this image may not be up to date and then have bugs. You should re-download -the VM every once in a while to be sure to have all the latest tools and potential bugs fixes. -You will find more information on this in the `cri.news` newsgroup. - -!!! warning - Be careful ! You should log with `epita` user and no password. Your data is in - `/home/epita`, this directory is kept between reboot, you will not lose files - each time you stop your VM. - - - -## Common issues - -### Error: failed to start Switch Root. - -![error-switch-root](assets/vm_error_switch_root.png) - -You probably didn't start the `Prepare disk` image, please do the third step -again. - -### Black screen after starting the VM - -Please ensure you are using VirtualBox 6.1 (you can check in -`Help -> About VirtualBox`). - -### Not in a hypervisor partition - -![virt-disabled](assets/vm_error_virt_disabled.png) - -You need to enable Vt-x or AMD-V in your BIOS. - -### Cannot enable nested VT-x/AMD-V without nested-paging - -![nested](assets/vm_error_nested.png) - -Go to the VM settings window and in the `System` page and `Processor` tab, -uncheck the `Enable nested Vt-x/AMD-V` box. - -### FATAL: Could not read from the boot medium! System halted - -![no-boot-medium-display](assets/vm_error_no_boot_medium-1.png) - -This issue often happens if you tried to install `VBoxGuestAdditions`. The -tools provided by VirtualBox are given as an ISO file. When you try to install -the tools, the ISO will replace your boot device. - -To fix this issue, you need to re-attach the original boot device to your VM. - -Go into your VM settings (`Settings -> Storage`) - -!!! warning - Be careful ! You should only edit the `Controller: IDE` section of the Storage settings. - -In the `Controller: IDE` section, you will either see nothing or the `VBoxGuestAdditions` iso. - -##### `Controller: IDE` section is empty -![no-boot-medium](assets/vm_error_no_boot_medium-2.png) - -Click on the little CD/ROM button on the `Controller: IDE` line. - -![add-boot-iso](assets/vm_error_no_boot_medium-3.png) - -Choose the iso called `PIE-disk001.iso`, it should have a size of ~1MB. - -![add-boot-iso-menu](assets/vm_error_no_boot_medium-4.png) - -You should now be able to boot your VM. - -##### VBoxGuestAdditions iso is present in the `Controller: IDE` section -![guest-additions](assets/vm_error_no_boot_medium-5.png) - -1. Select `VBoxGuestAdditions` iso. - -2. Click on the disk icon on the right of the menu. - -![guest-additions](assets/vm_error_no_boot_medium-6.png) - -Choose the iso called `PIE-disk001.iso`. - -![guest-additions](assets/vm_error_no_boot_medium-7.png) - -You should now be able to boot your VM. - - - - -## Small tips for a better environment - -### Screen resolution -You can use the command `xrandr` to change the resolution. - -You can see the available resolutions with `xrandr` as following : -![resolution](assets/resolution.png) - -You can change it using `xrandr --output Virtual-1 --auto --mode WIDTHxHEIGHT` -![xrandr](assets/xrandr.png) - -### Term size -A command line program allows you to change the font size in your terminal. - -You can use it with `term_size SIZE`. SIZE being the font size (12, 14, ... -for instance) - diff --git a/docs/from_home/afs.md b/docs/from_home/afs.md new file mode 100644 index 0000000000000000000000000000000000000000..196a319940403be212476ebb1fe8e9a15955c669 --- /dev/null +++ b/docs/from_home/afs.md @@ -0,0 +1,61 @@ +# Accessing the AFS from home + +CRI's AFS is accessible from outside the school's network using the SSH Gate. + +## Setup + +Add the following to your SSH config (`~/.ssh/config`): +``` +Host ssh.cri.epita.fr + GSSAPIAuthentication yes + GSSAPIDelegateCredentials yes +``` + +## Procedure + +Run `kinit -f login@CRI.EPITA.FR` (replace `login` with your login) and type in +your CRI password when asked. + +If you are using a SSH agent, make sure to disable it temporarily in your +current shell. This can be done by running `unset SSH_AUTH_SOCK`. + +## Browse interactively your AFS + +Run `sftp login@ssh.cri.epita.fr`, a SFTP prompt should show up. You can refer +to the `sftp(1)` man page to get familiar with the tool. + +If your login is `login`, your files are located in +`/afs/cri.epita.fr/user/l/lo/login/u/`. + +```shell +$ sftp marin.hannache@ssh.cri.epita.fr +Connected to ssh.cri.epita.fr. +sftp> cd /afs/cri.epita.fr/user/m/ma/marin.hannache/u/ +sftp> ls -la +drwxr-xr-x 3 marin.hannache 8000 2048 Sep 14 05:55 . +drwxrwxrwx 3 marin.hannache 8000 2048 Sep 14 2017 .. +drwxr-xr-x 9 marin.hannache 8000 2048 Oct 29 23:55 .confs +``` + +If you get a `Permission denied` error when trying to access to your files, you +very likely made a mistake in your setup. Make sure you did not connect using +your SSH Agent or through your SSH keys. + +## Mounting the AFS + +You can also mount the AFS to your Linux system (or the CRI VM) in a very +similar way as it is done at school. + +This can be done using the following commands: + +```shell +$ mkdir -p afs +$ sshfs -o reconnect login@ssh.cri.epita.fr:/afs/cri.epita.fr/user/l/lo/login/u/ afs +``` + +!!! warning + The files will not be accessible after the Kerberos ticket expires (usually + after a few days). If this happens, ask for a new ticket by running + `kinit -f login@CRI.EPITA.FR` and unmount the afs folder by running + `umount afs/`. You can then mount it again with the same `sshfs` command as + previously. diff --git a/docs/assets/add-usb.png b/docs/from_home/assets/add-usb.png similarity index 100% rename from docs/assets/add-usb.png rename to docs/from_home/assets/add-usb.png diff --git a/docs/assets/format.png b/docs/from_home/assets/format.png similarity index 100% rename from docs/assets/format.png rename to docs/from_home/assets/format.png diff --git a/docs/assets/settings.png b/docs/from_home/assets/settings.png similarity index 100% rename from docs/assets/settings.png rename to docs/from_home/assets/settings.png diff --git a/docs/assets/usb-disk-menu-ipxe.png b/docs/from_home/assets/usb-disk-menu-ipxe.png similarity index 100% rename from docs/assets/usb-disk-menu-ipxe.png rename to docs/from_home/assets/usb-disk-menu-ipxe.png diff --git a/docs/bare-metal.md b/docs/from_home/bare-metal.md similarity index 96% rename from docs/bare-metal.md rename to docs/from_home/bare-metal.md index cdfec97f8ae1bbfa898ba416b1f5eee6c5aaec47..cdf474cdf40cd459bb8b2427bbf4b8096da42172 100644 --- a/docs/bare-metal.md +++ b/docs/from_home/bare-metal.md @@ -35,7 +35,7 @@ Click on the `Storage` part Inside Virtual Box select your newly created virtual machine and click on the `Start` button. -![select](assets/vm_external_5.PNG) +![select](vm/assets/vm_external_5.PNG) In the familiar PXE menu, choose the `Prepare USB` entry. diff --git a/docs/from_home/docker.md b/docs/from_home/docker.md new file mode 100644 index 0000000000000000000000000000000000000000..bb939d8f451f0f3933d2a5a67bb8c54131bab846 --- /dev/null +++ b/docs/from_home/docker.md @@ -0,0 +1,11 @@ +# Docker Nix PIE + +Docker images that are close to the school's computer environment are available. +The list can be found by following [this +link](https://gitlab.cri.epita.fr/cri/infrastructure/nixpie/container_registry). + +## Example + +```shell +$ docker run --rm -ti registry.cri.epita.fr/cri/infrastructure/nixpie/nixos-pie:latest bash +``` diff --git a/docs/assets/import2_vmware.png b/docs/from_home/vm/assets/import2_vmware.png similarity index 100% rename from docs/assets/import2_vmware.png rename to docs/from_home/vm/assets/import2_vmware.png diff --git a/docs/assets/import_vmware.png b/docs/from_home/vm/assets/import_vmware.png similarity index 100% rename from docs/assets/import_vmware.png rename to docs/from_home/vm/assets/import_vmware.png diff --git a/docs/assets/macos_configure_1.png b/docs/from_home/vm/assets/macos_configure_1.png similarity index 100% rename from docs/assets/macos_configure_1.png rename to docs/from_home/vm/assets/macos_configure_1.png diff --git a/docs/assets/macos_configure_2.png b/docs/from_home/vm/assets/macos_configure_2.png similarity index 100% rename from docs/assets/macos_configure_2.png rename to docs/from_home/vm/assets/macos_configure_2.png diff --git a/docs/assets/macos_configure_3.png b/docs/from_home/vm/assets/macos_configure_3.png similarity index 100% rename from docs/assets/macos_configure_3.png rename to docs/from_home/vm/assets/macos_configure_3.png diff --git a/docs/assets/macos_configure_4.png b/docs/from_home/vm/assets/macos_configure_4.png similarity index 100% rename from docs/assets/macos_configure_4.png rename to docs/from_home/vm/assets/macos_configure_4.png diff --git a/docs/assets/macos_install_1.png b/docs/from_home/vm/assets/macos_install_1.png similarity index 100% rename from docs/assets/macos_install_1.png rename to docs/from_home/vm/assets/macos_install_1.png diff --git a/docs/assets/macos_install_2.png b/docs/from_home/vm/assets/macos_install_2.png similarity index 100% rename from docs/assets/macos_install_2.png rename to docs/from_home/vm/assets/macos_install_2.png diff --git a/docs/assets/macos_install_3.png b/docs/from_home/vm/assets/macos_install_3.png similarity index 100% rename from docs/assets/macos_install_3.png rename to docs/from_home/vm/assets/macos_install_3.png diff --git a/docs/assets/macos_install_4.png b/docs/from_home/vm/assets/macos_install_4.png similarity index 100% rename from docs/assets/macos_install_4.png rename to docs/from_home/vm/assets/macos_install_4.png diff --git a/docs/assets/macos_install_5.png b/docs/from_home/vm/assets/macos_install_5.png similarity index 100% rename from docs/assets/macos_install_5.png rename to docs/from_home/vm/assets/macos_install_5.png diff --git a/docs/assets/macos_launch.png b/docs/from_home/vm/assets/macos_launch.png similarity index 100% rename from docs/assets/macos_launch.png rename to docs/from_home/vm/assets/macos_launch.png diff --git a/docs/assets/resolution.png b/docs/from_home/vm/assets/resolution.png similarity index 100% rename from docs/assets/resolution.png rename to docs/from_home/vm/assets/resolution.png diff --git a/docs/assets/vm_error_nested.png b/docs/from_home/vm/assets/vm_error_nested.png similarity index 100% rename from docs/assets/vm_error_nested.png rename to docs/from_home/vm/assets/vm_error_nested.png diff --git a/docs/assets/vm_error_no_boot_medium-1.png b/docs/from_home/vm/assets/vm_error_no_boot_medium-1.png similarity index 100% rename from docs/assets/vm_error_no_boot_medium-1.png rename to docs/from_home/vm/assets/vm_error_no_boot_medium-1.png diff --git a/docs/assets/vm_error_no_boot_medium-2.png b/docs/from_home/vm/assets/vm_error_no_boot_medium-2.png similarity index 100% rename from docs/assets/vm_error_no_boot_medium-2.png rename to docs/from_home/vm/assets/vm_error_no_boot_medium-2.png diff --git a/docs/assets/vm_error_no_boot_medium-3.png b/docs/from_home/vm/assets/vm_error_no_boot_medium-3.png similarity index 100% rename from docs/assets/vm_error_no_boot_medium-3.png rename to docs/from_home/vm/assets/vm_error_no_boot_medium-3.png diff --git a/docs/assets/vm_error_no_boot_medium-4.png b/docs/from_home/vm/assets/vm_error_no_boot_medium-4.png similarity index 100% rename from docs/assets/vm_error_no_boot_medium-4.png rename to docs/from_home/vm/assets/vm_error_no_boot_medium-4.png diff --git a/docs/assets/vm_error_no_boot_medium-5.png b/docs/from_home/vm/assets/vm_error_no_boot_medium-5.png similarity index 100% rename from docs/assets/vm_error_no_boot_medium-5.png rename to docs/from_home/vm/assets/vm_error_no_boot_medium-5.png diff --git a/docs/assets/vm_error_no_boot_medium-6.png b/docs/from_home/vm/assets/vm_error_no_boot_medium-6.png similarity index 100% rename from docs/assets/vm_error_no_boot_medium-6.png rename to docs/from_home/vm/assets/vm_error_no_boot_medium-6.png diff --git a/docs/assets/vm_error_no_boot_medium-7.png b/docs/from_home/vm/assets/vm_error_no_boot_medium-7.png similarity index 100% rename from docs/assets/vm_error_no_boot_medium-7.png rename to docs/from_home/vm/assets/vm_error_no_boot_medium-7.png diff --git a/docs/assets/vm_error_switch_root.png b/docs/from_home/vm/assets/vm_error_switch_root.png similarity index 100% rename from docs/assets/vm_error_switch_root.png rename to docs/from_home/vm/assets/vm_error_switch_root.png diff --git a/docs/assets/vm_error_virt_disabled.png b/docs/from_home/vm/assets/vm_error_virt_disabled.png similarity index 100% rename from docs/assets/vm_error_virt_disabled.png rename to docs/from_home/vm/assets/vm_error_virt_disabled.png diff --git a/docs/assets/vm_external_1.PNG b/docs/from_home/vm/assets/vm_external_1.PNG similarity index 100% rename from docs/assets/vm_external_1.PNG rename to docs/from_home/vm/assets/vm_external_1.PNG diff --git a/docs/assets/vm_external_2.PNG b/docs/from_home/vm/assets/vm_external_2.PNG similarity index 100% rename from docs/assets/vm_external_2.PNG rename to docs/from_home/vm/assets/vm_external_2.PNG diff --git a/docs/assets/vm_external_3.PNG b/docs/from_home/vm/assets/vm_external_3.PNG similarity index 100% rename from docs/assets/vm_external_3.PNG rename to docs/from_home/vm/assets/vm_external_3.PNG diff --git a/docs/assets/vm_external_4.PNG b/docs/from_home/vm/assets/vm_external_4.PNG similarity index 100% rename from docs/assets/vm_external_4.PNG rename to docs/from_home/vm/assets/vm_external_4.PNG diff --git a/docs/assets/vm_external_5.PNG b/docs/from_home/vm/assets/vm_external_5.PNG similarity index 100% rename from docs/assets/vm_external_5.PNG rename to docs/from_home/vm/assets/vm_external_5.PNG diff --git a/docs/assets/vm_external_6.PNG b/docs/from_home/vm/assets/vm_external_6.PNG similarity index 100% rename from docs/assets/vm_external_6.PNG rename to docs/from_home/vm/assets/vm_external_6.PNG diff --git a/docs/assets/vmware.png b/docs/from_home/vm/assets/vmware.png similarity index 100% rename from docs/assets/vmware.png rename to docs/from_home/vm/assets/vmware.png diff --git a/docs/assets/vmware_ipxe.png b/docs/from_home/vm/assets/vmware_ipxe.png similarity index 100% rename from docs/assets/vmware_ipxe.png rename to docs/from_home/vm/assets/vmware_ipxe.png diff --git a/docs/assets/vmware_vm.png b/docs/from_home/vm/assets/vmware_vm.png similarity index 100% rename from docs/assets/vmware_vm.png rename to docs/from_home/vm/assets/vmware_vm.png diff --git a/docs/assets/xrandr.png b/docs/from_home/vm/assets/xrandr.png similarity index 100% rename from docs/assets/xrandr.png rename to docs/from_home/vm/assets/xrandr.png diff --git a/docs/from_home/vm/common_issues.md b/docs/from_home/vm/common_issues.md new file mode 100644 index 0000000000000000000000000000000000000000..89d28cdc6ffc6a27383a659a20f9bf0f6ce80e29 --- /dev/null +++ b/docs/from_home/vm/common_issues.md @@ -0,0 +1,71 @@ +# Common issues + +### Error: failed to start Switch Root. + +![error-switch-root](assets/vm_error_switch_root.png) + +You probably didn't start the `Prepare disk` image, please do the third step +again. + +### Black screen after starting the VM + +Please ensure you are using VirtualBox 6.1 (you can check in +`Help -> About VirtualBox`). + +### Not in a hypervisor partition + +![virt-disabled](assets/vm_error_virt_disabled.png) + +You need to enable VT-x or AMD-V in your BIOS. + +### Cannot enable nested VT-x/AMD-V without nested-paging + +![nested](assets/vm_error_nested.png) + +Go to the VM settings window and in the `System` page and `Processor` tab, +uncheck the `Enable nested Vt-x/AMD-V` box. + +### FATAL: Could not read from the boot medium! System halted + +![no-boot-medium-display](assets/vm_error_no_boot_medium-1.png) + +This issue often happens if you tried to install `VBoxGuestAdditions`. The +tools provided by VirtualBox are given as an ISO file. When you try to install +the tools, the ISO will replace your boot device. + +To fix this issue, you need to re-attach the original boot device to your VM. + +Go into your VM settings (`Settings -> Storage`) + +!!! warning + Be careful ! You should only edit the `Controller: IDE` section of the Storage settings. + +In the `Controller: IDE` section, you will either see nothing or the `VBoxGuestAdditions` iso. + +##### `Controller: IDE` section is empty +![no-boot-medium](assets/vm_error_no_boot_medium-2.png) + +Click on the little CD/ROM button on the `Controller: IDE` line. + +![add-boot-iso](assets/vm_error_no_boot_medium-3.png) + +Choose the iso called `PIE-disk001.iso`, it should have a size of ~1MB. + +![add-boot-iso-menu](assets/vm_error_no_boot_medium-4.png) + +You should now be able to boot your VM. + +##### VBoxGuestAdditions iso is present in the `Controller: IDE` section +![guest-additions](assets/vm_error_no_boot_medium-5.png) + +1. Select `VBoxGuestAdditions` iso. + +2. Click on the disk icon on the right of the menu. + +![guest-additions](assets/vm_error_no_boot_medium-6.png) + +Choose the iso called `PIE-disk001.iso`. + +![guest-additions](assets/vm_error_no_boot_medium-7.png) + +You should now be able to boot your VM. diff --git a/docs/from_home/vm/index.md b/docs/from_home/vm/index.md new file mode 100644 index 0000000000000000000000000000000000000000..76c9e096184354ef0ce10804cf80ac3df44fec59 --- /dev/null +++ b/docs/from_home/vm/index.md @@ -0,0 +1,12 @@ +# CRI VM + +!!! warning + No support is done by the CRI on the PIE VM. If you do not succeed in + making it work by your own means, you must work on the school computers. + +This method allow you to have the PIE environment running in a VM on your +computer. + +There are two installation types: [VirtualBox](virtualbox.md) and +[VMWare](vmware.md). Note that VirtualBox has shown numerous bugs on MacOS. +VMWare is thus recommended for MacOS users. diff --git a/docs/from_home/vm/tips.md b/docs/from_home/vm/tips.md new file mode 100644 index 0000000000000000000000000000000000000000..ee0c0f9f48415d2d266b83002829c7357fef2044 --- /dev/null +++ b/docs/from_home/vm/tips.md @@ -0,0 +1,17 @@ +# Tips and tricks + +## Screen resolution +You can use the command `xrandr` to change the resolution. + +You can see the available resolutions with `xrandr` as following : +![resolution](assets/resolution.png) + +You can change it using `xrandr --output Virtual-1 --auto --mode WIDTHxHEIGHT` +![xrandr](assets/xrandr.png) + +## Term size +A command line program allows you to change the font size in your terminal. + +You can use it with `term_size SIZE`. SIZE being the font size (12, 14, ... +for instance) + diff --git a/docs/from_home/vm/virtualbox.md b/docs/from_home/vm/virtualbox.md new file mode 100644 index 0000000000000000000000000000000000000000..8311d786ec4a4cdc31ed2a6810e61b92c99095ee --- /dev/null +++ b/docs/from_home/vm/virtualbox.md @@ -0,0 +1,55 @@ +# VirtualBox + +## Installation +### First step + +Install [VirtualBox](https://www.virtualbox.org/). + +On Linux you can install it with your package manager +([Debian](https://wiki.debian.org/VirtualBox) or [Arch +Linux](https://wiki.archlinux.org/index.php/VirtualBox)). + +### Second step + +Download our [VirtualBox appliance](https://static.cri.epita.fr/cri-vm.ova). + +Open VirtualBox and go to `File > Import Appliance` and import the file you just +downloaded. + +![appliance](assets/vm_external_1.PNG) + +![import](assets/vm_external_2.PNG) + +![folder](assets/vm_external_3.PNG) + +When getting to the `Appliance settings` page, you may adjust the RAM and CPU +parameters. Be careful to have a least 2048 MB of RAM. + +You can then click the `Import` button. + +![settings](assets/vm_external_4.PNG) + + +### Third step + +Inside VirtualBox select your newly created virtual machine and click on the +`Start` button. + +![select](assets/vm_external_5.PNG) + +In the familiar PXE menu, choose the `Prepare disk` entry. + +Let it boot, a script will run automatically and your VM will shutdown once it +is done. + +![menu](assets/vm_external_6.PNG) + +### Fourth step + +You can `Start` your VM again. You can now use the PXE menu as usual to boot +NixOS image. + +!!! warning + Be careful! You should log in with `epita` user and no password. Your data + is in `/home/epita`, this directory is kept between reboot, you will not + lose files each time you stop your VM. diff --git a/docs/from_home/vm/vmware.md b/docs/from_home/vm/vmware.md new file mode 100644 index 0000000000000000000000000000000000000000..784154ea1bd3d10854486ac98a8bfa77c9c309bb --- /dev/null +++ b/docs/from_home/vm/vmware.md @@ -0,0 +1,48 @@ +# VMWare + +## Installation + +### First step + +Install VMWare Workstation : [VMWare +Workstation](https://www.vmware.com/products/workstation-player/workstation-player-evaluation.html) +On Linux you can download it with your package manager +([Debian](https://wiki.debian.org/VMware) or [Arch +Linux](https://wiki.archlinux.org/index.php/VMware)). + +### Second step + +Download our [VMWare appliance](https://static.cri.epita.fr/vmware-cri-vm.zip). +Unzip the folder in an appropriate location (you can use +`unzip vmware-cri-vm.zip`). + +Click on `Open a Virtual Machine`. +![import](assets/vmware.png) + +Select the `CRI_VM` folder. +![import1](assets/import_vmware.png) + +Select the `CRI VM.vmx` file. +![import2](assets/import2_vmware.png) + +### Third step + +You now have an imported VM. You can now run it by double clicking on it. +![imported](assets/vmware_vm.png) + +In the familiar PXE menu, choose the `Prepare disk` entry. + +Let it boot, a script will run automatically and your VM will shutdown once its +done. + +![ipxemenu](assets/vmware_ipxe.png) + +### Fourth step + +You can `Start` your VM again. You can now use the PXE menu as usual to +boot NixOS image. + +!!! warning + Be careful! You should log in with `epita` user and no password. Your data + is in `/home/epita`, this directory is kept between reboot, you will not + lose files each time you stop your VM. diff --git a/docs/from_home/vm/vmware_macos.md b/docs/from_home/vm/vmware_macos.md new file mode 100644 index 0000000000000000000000000000000000000000..dea18a724f65f90abe21b9b09a1f30c0ba593b1b --- /dev/null +++ b/docs/from_home/vm/vmware_macos.md @@ -0,0 +1,64 @@ +# VMWare MacOS + +## Installation + +### First step +For MacOS, install VMWare Fusion : [VMWare +Fusion](https://www.vmware.com/go/downloadfusion). + +### Second step +Download the iso file [ISO](https://static.cri.epita.fr/cri-vm.iso). + +Click on `Installer à partir du disque ou de l'image`. +![import](assets/macos_install_1.png) + +Select the `cri-vm.iso` file. +![import1](assets/macos_install_2.png) + +Select `Linux` > `Autre noyau Linux 5.x et version ultérieur 64 bits`. +![import2](assets/macos_install_3.png) + +Select `BIOS hérité`. +![import2](assets/macos_install_4.png) + +Click on `Terminer` and save the VM. +![import2](assets/macos_install_5.png) + +Before launching the VM, you need to edit the configuration. +Go to `Machine Virtuelle` > `Paramètres`. +![import2](assets/macos_configure_1.png) + +Then edit `Processeurs et mémoires`. +![import2](assets/macos_configure_2.png) + +Put (at least) 4096MB of memory. Put more if you can - if you have *enough* RAM +available. (Note that 4GB will probably be the maximum on a 8GB Mac). +![import2](assets/macos_configure_3.png) + +Go back to the previous menu and click `Disque Dur (SCSI)`. +![import2](assets/macos_configure_2.png) + +Put (at least) 64GB of disk space. Note that the disk format is optimized not to +take that much space on your disk. +![import2](assets/macos_configure_4.png) + +### Third step +You now have an imported VM. You can now run it by double clicking on it. +![imported](assets/macos_launch.png) + +In the familiar PXE menu, choose the `Prepare disk` entry. + +Let it boot, a script will run automatically and your VM will shutdown once its +done. + +![ipxemenu](assets/vmware_ipxe.png) + +### Fourth step +You can `Start` your VM again. You can now use the PXE menu as usual to +boot NixOS image. + +!!! warning + Be careful! You should log in with `epita` user and no password. Your data + is in `/home/epita`, this directory is kept between reboot, you will not + lose files each time you stop your VM. + diff --git a/docs/afs.md b/docs/from_school/afs.md similarity index 81% rename from docs/afs.md rename to docs/from_school/afs.md index 47d9f0dd577f62e6354683c96e2274a63fb4d354..66f2f0b7ebe62a9103547cf136d132afc2eda857 100644 --- a/docs/afs.md +++ b/docs/from_school/afs.md @@ -22,7 +22,7 @@ It is possible to retrieve initial configuration in the folder : `/afs/cri.epita ## Access AFS folder of an other user -If you know the login and password of an user, you can access his afs folder from another session. It might be useful, for instance, if you can't log in your session because of corrupted config files and want to edit them using the anonym epita account. +If you know the login and password of an user, you can access his afs folder from another session. It might be useful, for instance, if you can't log in your session because of corrupted config files and want to edit them using the anonym `epita` account. To get the rights to edit the content of the afs folder of an user called `login`, you shall follow this process : @@ -30,8 +30,6 @@ To get the rights to edit the content of the afs folder of an user called `login * Enter `login`'s password * Execute `aklog` -If the user has a login of the form `firstname.lastname` (logins for new users since 2016), the argument for the first step have to be replaced with `kinit firstname_lastname`. - You can then execute `cd /afs/cri.epita.fr/user/l/lo/login/u/`, read and edit the content of `login`'s afs folder. -If you are using the anonym epita account, do not forget to execute `unlog && destroy` to destroy the token before logging out (alternatively, you may shutdown the computer). +If you are using the anonym `epita` account, do not forget to execute `unlog && kdestroy` to destroy the token before logging out (alternatively, you may shutdown the computer). diff --git a/docs/from_school/assets/wifi_android.jpg b/docs/from_school/assets/wifi_android.jpg new file mode 100644 index 0000000000000000000000000000000000000000..76e9120cc4590327ba3d8253c8724ed971afed11 Binary files /dev/null and b/docs/from_school/assets/wifi_android.jpg differ diff --git a/docs/map.md b/docs/from_school/map.md similarity index 65% rename from docs/map.md rename to docs/from_school/map.md index 229ee5aa95d774fa36e6331bbd78f6b65cf14f8a..316d54ffd70af5118e372b06af003120f8e28950 100644 --- a/docs/map.md +++ b/docs/from_school/map.md @@ -1,15 +1,10 @@ -# Map +# SM Map -!!! note - This feature is not yet available. - -CRI's intranet provides an interactive map of the computer rooms. This map -allows you to see the computers used by students in real time, the issues and -the heatmap. The issues on the map are used to replace the missing or broken -equipment, this means that it is important to report issues in order to have -fully functional computer rooms. - -The CRI's map can be accessed using menu on the left of the intranet. +CRI's [Fleet Manager](https://fleet.pie.cri.epita.fr) provides an interactive +map of the computer rooms. This map allows you to see the computers used by +students in real time, the issues and the heatmap. The issues on the map are +used to replace the missing or broken equipment, this means that it is important +to report issues in order to have fully functional computer rooms. ## Report a problem diff --git a/docs/netboot.md b/docs/from_school/netboot.md similarity index 100% rename from docs/netboot.md rename to docs/from_school/netboot.md diff --git a/docs/pie.md b/docs/from_school/pie.md similarity index 87% rename from docs/pie.md rename to docs/from_school/pie.md index 79b59cf592340f917cc9ba72087b74587dd24288..fbb363b771ef8008b51392b2f375dbb5c251d4d5 100644 --- a/docs/pie.md +++ b/docs/from_school/pie.md @@ -18,9 +18,9 @@ their projects. The images are loaded in the memory. Which means that the entirety of the modifications made outside of the AFS folders are lost on reboot. -## Epita account +## EPITA account -A [CRI account](accounts.md), without any password, is available at any moment +A [CRI account](/accounts/accounts/), without any password, is available at any moment The login is `epita`. It allows one to quickly log in on a computer, even without network (if it is already started, obviously). It is strongly recommended to turn off the computer after using this account to avoid people @@ -29,7 +29,7 @@ from retrieving data by re-logging on it. ## Student session Each student has a session on the network. To log on it, one has to use his -login and his CRI [password](passwords.md). +login and his CRI [password](/accounts/passwords/). Personal folders are stocked on [AFS](afs.md). It is essential to read this topic. diff --git a/docs/print.md b/docs/from_school/print.md similarity index 61% rename from docs/print.md rename to docs/from_school/print.md index a6d77743aedecacb2c9221f9ca76ffe75898cbf3..61eef2f098065d1ad01d34e004cce72b1b0595de 100644 --- a/docs/print.md +++ b/docs/from_school/print.md @@ -5,7 +5,7 @@ ## Villejuif - In Villejuif, there are two printers available for students. You can access those printers from any web browser +In Villejuif, there are two printers available for students. You can access those printers from any web browser while on the IONIS network: - [10.3.8.1](https://10.3.8.1) @@ -17,11 +17,12 @@ while on the IONIS network: - Ink percentage - Sheets quantity - You need to go in the *print* section to submit your documents. +You need to go in the *print* section to submit your documents. - > Be aware that only `.ps`, `.pdf`, `.prn` or `.rfu` files are supported. +!!! warning + Be aware that only `.ps`, `.pdf`, `.prn` or `.rfu` files are supported. ## Kremlin-Bicêtre -There are currently no printers available directly for students in the KB's +There are currently no printers available directly for students in the KB campus. diff --git a/docs/wifi.md b/docs/from_school/wifi.md similarity index 85% rename from docs/wifi.md rename to docs/from_school/wifi.md index 75ff1ffda3a68a3891d1300395f60eef7062bfe9..95d650ef455cae2a73798a75c8635f868944b292 100644 --- a/docs/wifi.md +++ b/docs/from_school/wifi.md @@ -3,31 +3,30 @@ Students have an open access to WiFi connection at school. EPITA provides two differents networks with various specifications detailled below. -```nohighlight -Your Bocal logins are required to connect to the WiFi network. -``` +!!! note + Your Bocal logins are required to connect to the WiFi network. ## IONIS -The IONIS WiFi hotspot **requires a 5 Ghz WiFi card**. The IONIS WiFi is +The `IONIS` WiFi hotspot **requires a 5 GHz WiFi card**. The `IONIS` WiFi is recommended as it provides a faster and more stable connection. -To connect on IONIS, follow these steps: +To connect on `IONIS`, follow these steps: -1. Connect to the IONIS WiFi hotspot -2. You will be asked for your logins. You need to log with your epita's email address and *Bocal*'s password. +1. Connect to the `IONIS` WiFi hotspot +2. You will be asked for your logins. You need to log with your EPITA email address and *Bocal* password. -## Archlinux configuration +## Arch Linux configuration -This section assumes you want to connect to the IONIS WiFi on an Archlinux +This section assumes you want to connect to the IONIS WiFi on an Arch Linux distribution, and have an activated WiFi interface. To get the name of your WiFi interface you can type: `$ iw dev`. This configuration is using **netctl**, a profile-based network manager -for Archlinux. +for Arch Linux. Thus, you will have to configure a network _profile_. A simple profile is presented below. For more information, please visit the -[Archlinux wiki on netctl](https://wiki.archlinux.org/index.php/netctl). +[Arch Linux wiki on netctl](https://wiki.archlinux.org/index.php/netctl). 1. Create a file in `/etc/netctl/`. Its name should be self-explanatory. A good name would be \-IONIS. @@ -59,6 +58,9 @@ passphrase and the SSID. Please refer to this You can find other configuration examples in `/etc/netctl/examples/`. +## Android configuration +![Android configuration](assets/wifi_android.jpg) + ## Troubleshooting ### TLS 1.0/1.1 diff --git a/docs/general/assets/thunderbird_news.png b/docs/general/assets/thunderbird_news.png new file mode 100644 index 0000000000000000000000000000000000000000..a65cac32018afa1a5760cc2d1b5f8338d7a789be Binary files /dev/null and b/docs/general/assets/thunderbird_news.png differ diff --git a/docs/general/assets/thunderbird_news_account.png b/docs/general/assets/thunderbird_news_account.png new file mode 100644 index 0000000000000000000000000000000000000000..a20ee46a0c24406a8b9665fe03c1c4e62a3ae7c8 Binary files /dev/null and b/docs/general/assets/thunderbird_news_account.png differ diff --git a/docs/general/contact.md b/docs/general/contact.md new file mode 100644 index 0000000000000000000000000000000000000000..7a1e3ee68cf3fa86731a05b76149e977c14ebe0b --- /dev/null +++ b/docs/general/contact.md @@ -0,0 +1,33 @@ +# Contact + +In general, in case of any problem / incident / question, one should turn to his +assistants and not directly to the Bocal or CRI. It is to the assistants +responsibility to try solve any problem or to contact the CRI or the Bocal if +needed. + +Any person contacting the Bocal without any justification might be punished. + +Any application towards assistants, the CRI or the Bocal must be as clear as +possible, with a maximum of information. + +## Exceptions + +It is possible to contact the CRI directly in case of any particular need or +suggestion regarding the IT workstation. If the requirement concerns a project, +one has to contact his assistants. + +## Bocal + +To contact the Bocal, one has to create a ticket on their +[Jira](https://jira.ionis-it.com) instance. + +## CRI + +To contact the CRI, one has to create a ticket by sending a mail at +[tickets@cri.epita.fr](mailto:tickets@cri.epita.fr). + +## Facebook / Discord + +Facebook, Discord and personal communication channels in general are not valid +ways to communicate with the school! Any person trying to contact the CRI via +this means will be punished. diff --git a/docs/git.md b/docs/general/git.md similarity index 61% rename from docs/git.md rename to docs/general/git.md index 3fb50e28969d3cfad4cf315b007f156b0ab4cd9e..c43bff7f84d095a7f0799b8c696fe20146e93ce7 100644 --- a/docs/git.md +++ b/docs/general/git.md @@ -9,20 +9,21 @@ OpenSSH provides a tool called `ssh-keygen` to generate and modify key pairs. You can learn more about its options by running `man 1 ssh-keygen`. A key pair is composed of a private key (without extension by default) and a -public key (.pub by default). +public key (`.pub` by default). To generate a key pair, you can use: ```bash ssh-keygen -a 100 -t ed25519 ``` -/!\ It is not recommended to generate a private key without passphrase. +!!! warning + It is not recommended to generate a private key without a passphrase. -## Pushing your public key +## Publishing your public key -Now that you own a key pair, you need to push your public key on the -[CRI Website](https://cri.epita.fr/). Your keys can be managed using `SSH Keys` -on your profile. +Now that you own a key pair, you need to publish your public key on the [CRI +Website](https://cri.epita.fr/). Your keys can be managed using `SSH Keys` on +your profile. Your public key can be retrieved using: ```bash @@ -40,10 +41,3 @@ commits. You can set them by using the following commands: git config --global user.name 'Firstname LASTNAME' git config --global user.email 'firstname.lastname@epita.fr' ``` - -## git-autoconfig - -A tool called git-autoconfig is available on Archlinux SUP. This script will -generate a key, configure your git and push your public key on the CRI website. -While this is the easiest way, this tool has its limitations. It is instead -recommended to follow the steps above for learning purpose. diff --git a/docs/general/news.md b/docs/general/news.md new file mode 100644 index 0000000000000000000000000000000000000000..6bc6defaa659b1e4093c02fecda103f165c0a51c --- /dev/null +++ b/docs/general/news.md @@ -0,0 +1,70 @@ +# News + +Newsgroups are the only official way of communication of EPITA. + +## Access + + * Server: news.cri.epita.fr + * Port: 563/tcp + * Authentication: use your CRI credentials + * Connection security: `SSL / TLS` + +Recommanded NNTP clients are the following: + + * slrn + * thunderbird + +## Thunderbird +### Procedure +In the following procedure, the example user is called "Xavier Login", their login +is `xavier.login` and their email address is `xavier.login@epita.fr`. + +To add the NNTP server, go to ☰ > New > Other accounts. + +In `Name`, insert your full name (example: "Xavier Login"). +In `Email address`, insert your EPITA email address (example: +`xavier.login@epita.fr`). + +In `Newsgroup Server`, insert `news.cri.epita.fr`. + +In the folder pane on the left of the main Thunederbird window, right click on +the newly added account (called `news.cri.epita.fr` if you didn't change it) and +click on `Settings`. Under `Server Settings`, select the correct +`Connection security` : `SSL/TLS`. + +Check the `Always request authentification when conneting to this server` box. + +We also recommend checking the two boxes about checking for new messages as you +will get notified when new messages are received on the server. + +![Thunderbird news config](assets/thunderbird_news.png) + +When prompted for a username and a password, fill in your login (example: +`xavier.login`) and your CRI password. Make sure to check the box to remember +the password. + +### Tips and tricks +The following configuration is strongly recommended as it is mandatory to +respect the "netiquette" on the News server. + +Still under the account settings, add a signature. + +![Thunderbird news config](assets/thunderbird_news_account.png) + +Under `Composition & Addressing`, make sure the HTML box is **unchecked**. + +Click the `Global Composing Preferences...` button, then the `Send Options...` +button. In the dialog, make sure the `Send messages as plain text if possible` +is checked, in the menu select `Ask me what to do` and in `Plain Text Domains` +add `*`. + +Finally, in ☰ > Preferences > General > Config Editor (at the bottom): + +- Set `mailnews.display.disable_format_flowed_support` to `true` +- Set `mailnews.send_plaintext_flowed` to `false` +- Set `mail.server.default.abbreviate` to `false` + +## slrn + +A tutorial is available [here](http://canartichaut.kawie.fr/essentiel-configuration-slrn/) +(in french). diff --git a/docs/index.md b/docs/index.md index e9be47bf1b68c543efb769c01884b9db7aaf2076..1b597fff11e5754ade82c6d9f4dd6ef81d4bd0cc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,16 +1,16 @@ # Home -## Epita documentation +## EPITA documentation -This site has for purpose to provide EPITA students a documentation regarding -IT tools at school. It is, for now, far from being complete, but it will be -updated. +The purpose of this website is to provide EPITA students a documentation +regarding IT tools at school. It is, for now, far from being complete, but it +will be updated. To stay tuned about those tools' news, one should refer to -[newsgroups](news.md), and especially cri.news. +[newsgroups](general/news.md), and especially `cri.news`. ## Contributions -To help keeping this documentation up to date, sources are available on our +To help keep this documentation up to date, sources are available on our [GitLab](https://gitlab.cri.epita.fr/cri/documentation/epita-doc). Pull requests, regarding either style or content, are welcome. diff --git a/docs/news.md b/docs/news.md deleted file mode 100644 index 605120af2f1b10b44bf4afacbd2fe431b35b9007..0000000000000000000000000000000000000000 --- a/docs/news.md +++ /dev/null @@ -1,19 +0,0 @@ -# News - -Newsgroups are the only official way of communication of Epita. - -## Accessibility - - * server: news.cri.epita.fr - * port: 563/tcp - * authentication: use your CRI credentials - * connection security: `SSL / TLS` - -The NNTP client should be used as followed: - - * slrn - * thunderbird - -## Slrn - -A tutorial is available [here](http://canartichaut.kawie.fr/essentiel-configuration-slrn/). diff --git a/docs/passwords.md b/docs/passwords.md deleted file mode 100644 index 31cad3c9eca005d73239babfd1bb6e0e1ed05c7f..0000000000000000000000000000000000000000 --- a/docs/passwords.md +++ /dev/null @@ -1,54 +0,0 @@ -# Changing your CRI password - -It is possible to change the password to your [CRI Account](accounts.md). - -## Password policy - -The password must be as follow: - - * At least 10 characters long - * Should have 3 different case (At least one uppercase character, one lower - case, and one numerical character) - * Not too similar to your other personal information. - * Different from a commonly used password. - -## Procedure - -To change one's password, one has to go to the [CRI intranet](https://cri.epita.fr/me). - -# Changing your Bocal password - -Your bocal password cannot be changed manually but it can be regenerated on the -[Bocal intranet](http://console.bocal.org). - - -# Password recovery - -## Recovering your Bocal password - -If you lost your Bocal password, which is giving you access to your `@epita.fr` -email and wifi, you have to send a reinitialization request following this -[link](https://console.bocal.org/#/recover). - -You will be asked your `@epita.fr` email, and a confirmation code will be sent -via SMS (or email if you posess an international number). Once this code has -been entered, your new password will be send to you via SMS (or, once again, -email). - -If the phone number kept by the Bocal for password recovery is missing or -simply erronous, you **must** send a ticket at -[tickets@cri.epita.fr](mailto:tickets@cri.epita.fr) indicating your login and a -french phone number. - -## Recovering your CRI password - -If you lost your CRI password, which is giving you access to the school's -computers, you can reinitialize it following this -[link](https://cri.epita.fr/auth/password/recovery/). - -You will be asked your login and an email will be send to the `@epita.fr` email -address linked to your CRI account, with instructions and a link for -reinitialization. - -You can also use the button `Instant recover with Office 365` which will use -your Bocal account to allow you to reset your password. diff --git a/mkdocs.yml b/mkdocs.yml index c158d83317911398406dac454119dd798e5d896c..58b625f9c29e0c02ced8c33c4c4be23e6f3e0fe6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,23 +6,33 @@ markdown_extensions: - admonition nav: - Home: 'index.md' - - Documentation: - - PIE: 'pie.md' - - 'git.md' - - 'wifi.md' - - Netboot : 'netboot.md' - - AFS: 'afs.md' - - 'map.md' - - 'news.md' - - 'print.md' - - CRI VM: 'cri_vm.md' - - Disk/USB Installation: 'bare-metal.md' + - General: + - 'general/git.md' + - 'general/news.md' + - 'general/contact.md' - Accounts: - - Cri and Bocal accounts: 'accounts.md' - - Recover and modify passwords: 'passwords.md' + - CRI and Bocal accounts: 'accounts/accounts.md' + - Recover and modify passwords: 'accounts/passwords.md' + - Working from school: + - PIE: 'from_school/pie.md' + - 'from_school/wifi.md' + - Netboot : 'from_school/netboot.md' + - AFS: 'from_school/afs.md' + - 'from_school/map.md' + - 'from_school/print.md' - Machines Room rules: 'charte.pdf' + - Working from home: + - CRI VM: + - 'from_home/vm/index.md' + - 'from_home/vm/virtualbox.md' + - 'from_home/vm/vmware.md' + - 'from_home/vm/vmware_macos.md' + - 'from_home/vm/common_issues.md' + - 'from_home/vm/tips.md' + - Disk/USB Installation: 'from_home/bare-metal.md' + - 'from_home/docker.md' + - AFS: 'from_home/afs.md' - Contributing: - - 'map_contributing.md' - - 'doc_contributing.md' - - Contact: 'contact.md' - + - 'contributing/contributing.md' + - 'contributing/map.md' + - 'contributing/doc.md' diff --git a/poetry.lock b/poetry.lock new file mode 100644 index 0000000000000000000000000000000000000000..9ad200b418234fc64fb34a55ca2c3f558b588135 --- /dev/null +++ b/poetry.lock @@ -0,0 +1,363 @@ +[[package]] +name = "click" +version = "8.0.4" +description = "Composable command line interface toolkit" +category = "main" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +colorama = {version = "*", markers = "platform_system == \"Windows\""} + +[[package]] +name = "colorama" +version = "0.4.4" +description = "Cross-platform colored terminal text." +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" + +[[package]] +name = "ghp-import" +version = "2.0.2" +description = "Copy your docs directly to the gh-pages branch." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +python-dateutil = ">=2.8.1" + +[package.extras] +dev = ["twine", "markdown", "flake8", "wheel"] + +[[package]] +name = "importlib-metadata" +version = "4.11.2" +description = "Read metadata from Python packages" +category = "main" +optional = false +python-versions = ">=3.7" + +[package.dependencies] +zipp = ">=0.5" + +[package.extras] +docs = ["sphinx", "jaraco.packaging (>=9)", "rst.linker (>=1.9)"] +perf = ["ipython"] +testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytest-cov", "pytest-enabler (>=1.0.1)", "packaging", "pyfakefs", "flufl.flake8", "pytest-perf (>=0.9.2)", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)", "importlib-resources (>=1.3)"] + +[[package]] +name = "jinja2" +version = "3.0.3" +description = "A very fast and expressive template engine." +category = "main" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +MarkupSafe = ">=2.0" + +[package.extras] +i18n = ["Babel (>=2.7)"] + +[[package]] +name = "markdown" +version = "3.3.6" +description = "Python implementation of Markdown." +category = "main" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""} + +[package.extras] +testing = ["coverage", "pyyaml"] + +[[package]] +name = "markupsafe" +version = "2.1.0" +description = "Safely add untrusted strings to HTML/XML markup." +category = "main" +optional = false +python-versions = ">=3.7" + +[[package]] +name = "mergedeep" +version = "1.3.4" +description = "A deep merge function for 🐍." +category = "main" +optional = false +python-versions = ">=3.6" + +[[package]] +name = "mkdocs" +version = "1.2.3" +description = "Project documentation with Markdown." +category = "main" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +click = ">=3.3" +ghp-import = ">=1.0" +importlib-metadata = ">=3.10" +Jinja2 = ">=2.10.1" +Markdown = ">=3.2.1" +mergedeep = ">=1.3.4" +packaging = ">=20.5" +PyYAML = ">=3.10" +pyyaml-env-tag = ">=0.1" +watchdog = ">=2.0" + +[package.extras] +i18n = ["babel (>=2.9.0)"] + +[[package]] +name = "packaging" +version = "21.3" +description = "Core utilities for Python packages" +category = "main" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +pyparsing = ">=2.0.2,<3.0.5 || >3.0.5" + +[[package]] +name = "pyparsing" +version = "3.0.7" +description = "Python parsing module" +category = "main" +optional = false +python-versions = ">=3.6" + +[package.extras] +diagrams = ["jinja2", "railroad-diagrams"] + +[[package]] +name = "python-dateutil" +version = "2.8.2" +description = "Extensions to the standard Python datetime module" +category = "main" +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" + +[package.dependencies] +six = ">=1.5" + +[[package]] +name = "pyyaml" +version = "6.0" +description = "YAML parser and emitter for Python" +category = "main" +optional = false +python-versions = ">=3.6" + +[[package]] +name = "pyyaml-env-tag" +version = "0.1" +description = "A custom YAML tag for referencing environment variables in YAML files. " +category = "main" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +pyyaml = "*" + +[[package]] +name = "six" +version = "1.16.0" +description = "Python 2 and 3 compatibility utilities" +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" + +[[package]] +name = "watchdog" +version = "2.1.6" +description = "Filesystem events monitoring" +category = "main" +optional = false +python-versions = ">=3.6" + +[package.extras] +watchmedo = ["PyYAML (>=3.10)"] + +[[package]] +name = "zipp" +version = "3.7.0" +description = "Backport of pathlib-compatible object wrapper for zip files" +category = "main" +optional = false +python-versions = ">=3.7" + +[package.extras] +docs = ["sphinx", "jaraco.packaging (>=8.2)", "rst.linker (>=1.9)"] +testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytest-cov", "pytest-enabler (>=1.0.1)", "jaraco.itertools", "func-timeout", "pytest-black (>=0.3.7)", "pytest-mypy"] + +[metadata] +lock-version = "1.1" +python-versions = "^3.9" +content-hash = "a887b5fc08f2392ce4edd3d1f1dc9f346dc011e595e0225b727d970e1802a151" + +[metadata.files] +click = [ + {file = "click-8.0.4-py3-none-any.whl", hash = "sha256:6a7a62563bbfabfda3a38f3023a1db4a35978c0abd76f6c9605ecd6554d6d9b1"}, + {file = "click-8.0.4.tar.gz", hash = "sha256:8458d7b1287c5fb128c90e23381cf99dcde74beaf6c7ff6384ce84d6fe090adb"}, +] +colorama = [ + {file = "colorama-0.4.4-py2.py3-none-any.whl", hash = "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2"}, + {file = "colorama-0.4.4.tar.gz", hash = "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b"}, +] +ghp-import = [ + {file = "ghp-import-2.0.2.tar.gz", hash = "sha256:947b3771f11be850c852c64b561c600fdddf794bab363060854c1ee7ad05e071"}, + {file = "ghp_import-2.0.2-py3-none-any.whl", hash = "sha256:5f8962b30b20652cdffa9c5a9812f7de6bcb56ec475acac579807719bf242c46"}, +] +importlib-metadata = [ + {file = "importlib_metadata-4.11.2-py3-none-any.whl", hash = "sha256:d16e8c1deb60de41b8e8ed21c1a7b947b0bc62fab7e1d470bcdf331cea2e6735"}, + {file = "importlib_metadata-4.11.2.tar.gz", hash = "sha256:b36ffa925fe3139b2f6ff11d6925ffd4fa7bc47870165e3ac260ac7b4f91e6ac"}, +] +jinja2 = [ + {file = "Jinja2-3.0.3-py3-none-any.whl", hash = "sha256:077ce6014f7b40d03b47d1f1ca4b0fc8328a692bd284016f806ed0eaca390ad8"}, + {file = "Jinja2-3.0.3.tar.gz", hash = "sha256:611bb273cd68f3b993fabdc4064fc858c5b47a973cb5aa7999ec1ba405c87cd7"}, +] +markdown = [ + {file = "Markdown-3.3.6-py3-none-any.whl", hash = "sha256:9923332318f843411e9932237530df53162e29dc7a4e2b91e35764583c46c9a3"}, + {file = "Markdown-3.3.6.tar.gz", hash = "sha256:76df8ae32294ec39dcf89340382882dfa12975f87f45c3ed1ecdb1e8cefc7006"}, +] +markupsafe = [ + {file = "MarkupSafe-2.1.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:3028252424c72b2602a323f70fbf50aa80a5d3aa616ea6add4ba21ae9cc9da4c"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:290b02bab3c9e216da57c1d11d2ba73a9f73a614bbdcc027d299a60cdfabb11a"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6e104c0c2b4cd765b4e83909cde7ec61a1e313f8a75775897db321450e928cce"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:24c3be29abb6b34052fd26fc7a8e0a49b1ee9d282e3665e8ad09a0a68faee5b3"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:204730fd5fe2fe3b1e9ccadb2bd18ba8712b111dcabce185af0b3b5285a7c989"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:d3b64c65328cb4cd252c94f83e66e3d7acf8891e60ebf588d7b493a55a1dbf26"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:96de1932237abe0a13ba68b63e94113678c379dca45afa040a17b6e1ad7ed076"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:75bb36f134883fdbe13d8e63b8675f5f12b80bb6627f7714c7d6c5becf22719f"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-win32.whl", hash = "sha256:4056f752015dfa9828dce3140dbadd543b555afb3252507348c493def166d454"}, + {file = "MarkupSafe-2.1.0-cp310-cp310-win_amd64.whl", hash = "sha256:d4e702eea4a2903441f2735799d217f4ac1b55f7d8ad96ab7d4e25417cb0827c"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:f0eddfcabd6936558ec020130f932d479930581171368fd728efcfb6ef0dd357"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5ddea4c352a488b5e1069069f2f501006b1a4362cb906bee9a193ef1245a7a61"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:09c86c9643cceb1d87ca08cdc30160d1b7ab49a8a21564868921959bd16441b8"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a0a0abef2ca47b33fb615b491ce31b055ef2430de52c5b3fb19a4042dbc5cadb"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:736895a020e31b428b3382a7887bfea96102c529530299f426bf2e636aacec9e"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:679cbb78914ab212c49c67ba2c7396dc599a8479de51b9a87b174700abd9ea49"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:84ad5e29bf8bab3ad70fd707d3c05524862bddc54dc040982b0dbcff36481de7"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-win32.whl", hash = "sha256:8da5924cb1f9064589767b0f3fc39d03e3d0fb5aa29e0cb21d43106519bd624a"}, + {file = "MarkupSafe-2.1.0-cp37-cp37m-win_amd64.whl", hash = "sha256:454ffc1cbb75227d15667c09f164a0099159da0c1f3d2636aa648f12675491ad"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:142119fb14a1ef6d758912b25c4e803c3ff66920635c44078666fe7cc3f8f759"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:b2a5a856019d2833c56a3dcac1b80fe795c95f401818ea963594b345929dffa7"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1d1fb9b2eec3c9714dd936860850300b51dbaa37404209c8d4cb66547884b7ed"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:62c0285e91414f5c8f621a17b69fc0088394ccdaa961ef469e833dbff64bd5ea"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fc3150f85e2dbcf99e65238c842d1cfe69d3e7649b19864c1cc043213d9cd730"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:f02cf7221d5cd915d7fa58ab64f7ee6dd0f6cddbb48683debf5d04ae9b1c2cc1"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:d5653619b3eb5cbd35bfba3c12d575db2a74d15e0e1c08bf1db788069d410ce8"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:7d2f5d97fcbd004c03df8d8fe2b973fe2b14e7bfeb2cfa012eaa8759ce9a762f"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-win32.whl", hash = "sha256:3cace1837bc84e63b3fd2dfce37f08f8c18aeb81ef5cf6bb9b51f625cb4e6cd8"}, + {file = "MarkupSafe-2.1.0-cp38-cp38-win_amd64.whl", hash = "sha256:fabbe18087c3d33c5824cb145ffca52eccd053061df1d79d4b66dafa5ad2a5ea"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:023af8c54fe63530545f70dd2a2a7eed18d07a9a77b94e8bf1e2ff7f252db9a3"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:d66624f04de4af8bbf1c7f21cc06649c1c69a7f84109179add573ce35e46d448"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c532d5ab79be0199fa2658e24a02fce8542df196e60665dd322409a03db6a52c"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e67ec74fada3841b8c5f4c4f197bea916025cb9aa3fe5abf7d52b655d042f956"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:30c653fde75a6e5eb814d2a0a89378f83d1d3f502ab710904ee585c38888816c"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:961eb86e5be7d0973789f30ebcf6caab60b844203f4396ece27310295a6082c7"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:598b65d74615c021423bd45c2bc5e9b59539c875a9bdb7e5f2a6b92dfcfc268d"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:599941da468f2cf22bf90a84f6e2a65524e87be2fce844f96f2dd9a6c9d1e635"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-win32.whl", hash = "sha256:e6f7f3f41faffaea6596da86ecc2389672fa949bd035251eab26dc6697451d05"}, + {file = "MarkupSafe-2.1.0-cp39-cp39-win_amd64.whl", hash = "sha256:b8811d48078d1cf2a6863dafb896e68406c5f513048451cd2ded0473133473c7"}, + {file = "MarkupSafe-2.1.0.tar.gz", hash = "sha256:80beaf63ddfbc64a0452b841d8036ca0611e049650e20afcb882f5d3c266d65f"}, +] +mergedeep = [ + {file = "mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307"}, + {file = "mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8"}, +] +mkdocs = [ + {file = "mkdocs-1.2.3-py3-none-any.whl", hash = "sha256:a1fa8c2d0c1305d7fc2b9d9f607c71778572a8b110fb26642aa00296c9e6d072"}, + {file = "mkdocs-1.2.3.tar.gz", hash = "sha256:89f5a094764381cda656af4298727c9f53dc3e602983087e1fe96ea1df24f4c1"}, +] +packaging = [ + {file = "packaging-21.3-py3-none-any.whl", hash = "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"}, + {file = "packaging-21.3.tar.gz", hash = "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb"}, +] +pyparsing = [ + {file = "pyparsing-3.0.7-py3-none-any.whl", hash = "sha256:a6c06a88f252e6c322f65faf8f418b16213b51bdfaece0524c1c1bc30c63c484"}, + {file = "pyparsing-3.0.7.tar.gz", hash = "sha256:18ee9022775d270c55187733956460083db60b37d0d0fb357445f3094eed3eea"}, +] +python-dateutil = [ + {file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"}, + {file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"}, +] +pyyaml = [ + {file = "PyYAML-6.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d4db7c7aef085872ef65a8fd7d6d09a14ae91f691dec3e87ee5ee0539d516f53"}, + {file = "PyYAML-6.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9df7ed3b3d2e0ecfe09e14741b857df43adb5a3ddadc919a2d94fbdf78fea53c"}, + {file = "PyYAML-6.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:77f396e6ef4c73fdc33a9157446466f1cff553d979bd00ecb64385760c6babdc"}, + {file = "PyYAML-6.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a80a78046a72361de73f8f395f1f1e49f956c6be882eed58505a15f3e430962b"}, + {file = "PyYAML-6.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:f84fbc98b019fef2ee9a1cb3ce93e3187a6df0b2538a651bfb890254ba9f90b5"}, + {file = "PyYAML-6.0-cp310-cp310-win32.whl", hash = "sha256:2cd5df3de48857ed0544b34e2d40e9fac445930039f3cfe4bcc592a1f836d513"}, + {file = "PyYAML-6.0-cp310-cp310-win_amd64.whl", hash = "sha256:daf496c58a8c52083df09b80c860005194014c3698698d1a57cbcfa182142a3a"}, + {file = "PyYAML-6.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:897b80890765f037df3403d22bab41627ca8811ae55e9a722fd0392850ec4d86"}, + {file = "PyYAML-6.0-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:50602afada6d6cbfad699b0c7bb50d5ccffa7e46a3d738092afddc1f9758427f"}, + {file = "PyYAML-6.0-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:48c346915c114f5fdb3ead70312bd042a953a8ce5c7106d5bfb1a5254e47da92"}, + {file = "PyYAML-6.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:98c4d36e99714e55cfbaaee6dd5badbc9a1ec339ebfc3b1f52e293aee6bb71a4"}, + {file = "PyYAML-6.0-cp36-cp36m-win32.whl", hash = "sha256:0283c35a6a9fbf047493e3a0ce8d79ef5030852c51e9d911a27badfde0605293"}, + {file = "PyYAML-6.0-cp36-cp36m-win_amd64.whl", hash = "sha256:07751360502caac1c067a8132d150cf3d61339af5691fe9e87803040dbc5db57"}, + {file = "PyYAML-6.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:819b3830a1543db06c4d4b865e70ded25be52a2e0631ccd2f6a47a2822f2fd7c"}, + {file = "PyYAML-6.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:473f9edb243cb1935ab5a084eb238d842fb8f404ed2193a915d1784b5a6b5fc0"}, + {file = "PyYAML-6.0-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0ce82d761c532fe4ec3f87fc45688bdd3a4c1dc5e0b4a19814b9009a29baefd4"}, + {file = "PyYAML-6.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:231710d57adfd809ef5d34183b8ed1eeae3f76459c18fb4a0b373ad56bedcdd9"}, + {file = "PyYAML-6.0-cp37-cp37m-win32.whl", hash = "sha256:c5687b8d43cf58545ade1fe3e055f70eac7a5a1a0bf42824308d868289a95737"}, + {file = "PyYAML-6.0-cp37-cp37m-win_amd64.whl", hash = "sha256:d15a181d1ecd0d4270dc32edb46f7cb7733c7c508857278d3d378d14d606db2d"}, + {file = "PyYAML-6.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:0b4624f379dab24d3725ffde76559cff63d9ec94e1736b556dacdfebe5ab6d4b"}, + {file = "PyYAML-6.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:213c60cd50106436cc818accf5baa1aba61c0189ff610f64f4a3e8c6726218ba"}, + {file = "PyYAML-6.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9fa600030013c4de8165339db93d182b9431076eb98eb40ee068700c9c813e34"}, + {file = "PyYAML-6.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:277a0ef2981ca40581a47093e9e2d13b3f1fbbeffae064c1d21bfceba2030287"}, + {file = "PyYAML-6.0-cp38-cp38-win32.whl", hash = "sha256:d4eccecf9adf6fbcc6861a38015c2a64f38b9d94838ac1810a9023a0609e1b78"}, + {file = "PyYAML-6.0-cp38-cp38-win_amd64.whl", hash = "sha256:1e4747bc279b4f613a09eb64bba2ba602d8a6664c6ce6396a4d0cd413a50ce07"}, + {file = "PyYAML-6.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:055d937d65826939cb044fc8c9b08889e8c743fdc6a32b33e2390f66013e449b"}, + {file = "PyYAML-6.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:e61ceaab6f49fb8bdfaa0f92c4b57bcfbea54c09277b1b4f7ac376bfb7a7c174"}, + {file = "PyYAML-6.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d67d839ede4ed1b28a4e8909735fc992a923cdb84e618544973d7dfc71540803"}, + {file = "PyYAML-6.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cba8c411ef271aa037d7357a2bc8f9ee8b58b9965831d9e51baf703280dc73d3"}, + {file = "PyYAML-6.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:40527857252b61eacd1d9af500c3337ba8deb8fc298940291486c465c8b46ec0"}, + {file = "PyYAML-6.0-cp39-cp39-win32.whl", hash = "sha256:b5b9eccad747aabaaffbc6064800670f0c297e52c12754eb1d976c57e4f74dcb"}, + {file = "PyYAML-6.0-cp39-cp39-win_amd64.whl", hash = "sha256:b3d267842bf12586ba6c734f89d1f5b871df0273157918b0ccefa29deb05c21c"}, + {file = "PyYAML-6.0.tar.gz", hash = "sha256:68fb519c14306fec9720a2a5b45bc9f0c8d1b9c72adf45c37baedfcd949c35a2"}, +] +pyyaml-env-tag = [ + {file = "pyyaml_env_tag-0.1-py3-none-any.whl", hash = "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069"}, + {file = "pyyaml_env_tag-0.1.tar.gz", hash = "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb"}, +] +six = [ + {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, + {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, +] +watchdog = [ + {file = "watchdog-2.1.6-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:9693f35162dc6208d10b10ddf0458cc09ad70c30ba689d9206e02cd836ce28a3"}, + {file = "watchdog-2.1.6-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:aba5c812f8ee8a3ff3be51887ca2d55fb8e268439ed44110d3846e4229eb0e8b"}, + {file = "watchdog-2.1.6-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:4ae38bf8ba6f39d5b83f78661273216e7db5b00f08be7592062cb1fc8b8ba542"}, + {file = "watchdog-2.1.6-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:ad6f1796e37db2223d2a3f302f586f74c72c630b48a9872c1e7ae8e92e0ab669"}, + {file = "watchdog-2.1.6-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:922a69fa533cb0c793b483becaaa0845f655151e7256ec73630a1b2e9ebcb660"}, + {file = "watchdog-2.1.6-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:b2fcf9402fde2672545b139694284dc3b665fd1be660d73eca6805197ef776a3"}, + {file = "watchdog-2.1.6-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:3386b367e950a11b0568062b70cc026c6f645428a698d33d39e013aaeda4cc04"}, + {file = "watchdog-2.1.6-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:8f1c00aa35f504197561060ca4c21d3cc079ba29cf6dd2fe61024c70160c990b"}, + {file = "watchdog-2.1.6-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:b52b88021b9541a60531142b0a451baca08d28b74a723d0c99b13c8c8d48d604"}, + {file = "watchdog-2.1.6-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:8047da932432aa32c515ec1447ea79ce578d0559362ca3605f8e9568f844e3c6"}, + {file = "watchdog-2.1.6-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:e92c2d33858c8f560671b448205a268096e17870dcf60a9bb3ac7bfbafb7f5f9"}, + {file = "watchdog-2.1.6-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:b7d336912853d7b77f9b2c24eeed6a5065d0a0cc0d3b6a5a45ad6d1d05fb8cd8"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_aarch64.whl", hash = "sha256:cca7741c0fcc765568350cb139e92b7f9f3c9a08c4f32591d18ab0a6ac9e71b6"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_armv7l.whl", hash = "sha256:25fb5240b195d17de949588628fdf93032ebf163524ef08933db0ea1f99bd685"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_i686.whl", hash = "sha256:be9be735f827820a06340dff2ddea1fb7234561fa5e6300a62fe7f54d40546a0"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_ppc64.whl", hash = "sha256:d0d19fb2441947b58fbf91336638c2b9f4cc98e05e1045404d7a4cb7cddc7a65"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:3becdb380d8916c873ad512f1701f8a92ce79ec6978ffde92919fd18d41da7fb"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_s390x.whl", hash = "sha256:ae67501c95606072aafa865b6ed47343ac6484472a2f95490ba151f6347acfc2"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_x86_64.whl", hash = "sha256:e0f30db709c939cabf64a6dc5babb276e6d823fd84464ab916f9b9ba5623ca15"}, + {file = "watchdog-2.1.6-py3-none-win32.whl", hash = "sha256:e02794ac791662a5eafc6ffeaf9bcc149035a0e48eb0a9d40a8feb4622605a3d"}, + {file = "watchdog-2.1.6-py3-none-win_amd64.whl", hash = "sha256:bd9ba4f332cf57b2c1f698be0728c020399ef3040577cde2939f2e045b39c1e5"}, + {file = "watchdog-2.1.6-py3-none-win_ia64.whl", hash = "sha256:a0f1c7edf116a12f7245be06120b1852275f9506a7d90227648b250755a03923"}, + {file = "watchdog-2.1.6.tar.gz", hash = "sha256:a36e75df6c767cbf46f61a91c70b3ba71811dfa0aca4a324d9407a06a8b7a2e7"}, +] +zipp = [ + {file = "zipp-3.7.0-py3-none-any.whl", hash = "sha256:b47250dd24f92b7dd6a0a8fc5244da14608f3ca90a5efcd37a3b1642fac9a375"}, + {file = "zipp-3.7.0.tar.gz", hash = "sha256:9f50f446828eb9d45b267433fd3e9da8d801f614129124863f9c51ebceafb87d"}, +] diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000000000000000000000000000000000000..9bafd574ae97f60654246bf789aff06b839fa867 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,15 @@ +[tool.poetry] +name = "epita-doc" +version = "0.1.0" +description = "CRI Documentation website" +authors = ["CRI - EPITA "] + +[tool.poetry.dependencies] +python = "^3.9" +mkdocs = "*" + +[tool.poetry.dev-dependencies] + +[build-system] +requires = ["poetry-core>=1.0.0"] +build-backend = "poetry.core.masonry.api"