Skip to content
Snippets Groups Projects
Commit 0b932cd9 authored by Djouadar Mohammad's avatar Djouadar Mohammad
Browse files

Ecriture du ReadME

parent 778a16f2
Branches
No related tags found
No related merge requests found
# NetHub
| Projet Nethub |
|-----------------------------------|
| Mohammad Djouadar
| Ozcan Asci
| Valentin Claisse
| Esraa Haroun Yahia
| Création d'un Réseau d'Entreprise |
| Superviseur |
| Yvan Peter |
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
![](/docs/imgs/schema.png)
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
# Présentation du Projet
## Add your files
L’objectif du projet est de mettre en place une infrastructure d’entreprise ayant les caractéristiques suivantes :
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
— Le réseau comporte une partie publique accessible de l’extérieur (i.e., les autres groupes) et une partie privée pour les machines utilisateurs.
```
cd existing_repo
git remote add origin https://gitlab.univ-lille.fr/valentin.claisse.etu/nethub.git
git branch -M main
git push -uf origin main
```
— Chaque groupe hébergera un serveur Web accessible aux autres groupes.
## Integrate with your tools
— Les utilisateurs pourront s’échanger des mails y compris d’un groupe à l’autre.
- [ ] [Set up project integrations](https://gitlab.univ-lille.fr/valentin.claisse.etu/nethub/-/settings/integrations)
— La partie privée sera sécurisé par un PC sous linux.
## Collaborate with your team
— Les adresses de la partie privée seront en adressage privé et ne devront pas être visible à
l’extérieur.
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
— Les machines de la partie privée appartiennent soit au département comptabilité soit au département production. Les flux de ces différents départements devront être séparés pour assurer la qualité de service du réseau. Toutefois, une communication entre les machines des deux départements doit rester possible.
## Test and Deploy
— De manière à faciliter la vie de l’administrateur et des utilisateurs, les machines utilisateur seront configurées dynamiquement. Les différentes machines utilisateurs ainsi que les serveurs pourront être désignés par un nom.
Use the built-in continuous integration in GitLab.
Si l’ensemble de ces éléments a pu être mis en œuvre avant la fin du projet, on pourra mettre en place les éléments suivants :
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
— Fournir l’ensemble des services en IPv4 et en IPv6
***
— Offrir un accès sécurisé depuis un réseau extérieur (VPN).
# Editing this README
— Offrir aux utilisateurs un accès Wifi. Le flux correspondant sera séparé des autres flux et permettra uniquement le flux HTTP.
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
Chaque groupe désignera un membre chargé de la mise en œuvre de l’infrastructure commune permettant de relier les différentes entreprises.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
# Remerciements
## Name
Choose a self-explaining name for your project.
Nous tenons à d'abord remercier :
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
- **Yvan Peter** et **Michael Hauspie** : Pour avoir aider et conseiller l'ensemble des équipes.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
- **L'IUT A de Lille** : Pour nous avoir fourni le matériel permettant la réalisation du projet.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
# Structure de ce dépôt
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
* [`configs`](configs) contient les configurations routeurs, switch et certaines informations sur le réseau.
* [`docs`](docs) contient les fichiers de rapport et procédures.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
# Détails sur le projet
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Plan d'addressage IP :
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
VLAN 2 (Administration) : 192.168.10.254/24
VLAN 3 (Comptabilité) : 192.168.20.254/24
VLAN 4 (Production) : 192.168.30.254/24
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
- PC Admin. sous Debian : 192.168.10.1
- DHCP (isc-dhcp-server): 192.168.10.12
- DNS (bind9) : 192.168.10.10
- Web (Apache2) : 192.168.10.11
- Firewall (non-utilisé): IPtables -> ACLs
- Mail (Postfix) :
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment