WIP documentation
This commit is contained in:
parent
762b9ed2d4
commit
8103b8e66c
199
README.md
199
README.md
|
|
@ -1,92 +1,179 @@
|
||||||
# Service COFFRE
|
# Service COFFRE
|
||||||
|
|
||||||
|
## Installation de Vaultwarden
|
||||||
|
|
||||||
|
### Installation des dépendances
|
||||||
|
|
||||||
## Getting started
|
#### Installation de la chaîne de compilation rustup
|
||||||
|
|
||||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
Récupération du script d'installation de rustup et exécution
|
||||||
|
|
||||||
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)!
|
curl https://sh.rustup.rs -sSf | sh
|
||||||
|
|
||||||
## Add your files
|
Ajout du chemin de la chaîne de compilation dans la variable `PATH`
|
||||||
|
|
||||||
- [ ] [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
|
echo 'export PATH=~/.cargo/bin:$PATH' >> ~/.bashrc
|
||||||
- [ ] [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:
|
|
||||||
|
### Compilation du serveur
|
||||||
|
|
||||||
|
On compile avec rust le serveur, en nettoyant bien avant.
|
||||||
|
|
||||||
|
cargo clean
|
||||||
|
cargo build --features sqlite --release
|
||||||
|
|
||||||
|
### Installation du serveur
|
||||||
|
|
||||||
|
Installation du fichier de configuration par défaut
|
||||||
|
|
||||||
|
sudo cp ../../.env.template /etc/vaultwarden.env
|
||||||
|
|
||||||
|
Installation du binaire
|
||||||
|
|
||||||
|
sudo cp vaultwarden /usr/bin/vaultwarden
|
||||||
|
|
||||||
|
Création du dossier des données
|
||||||
|
|
||||||
|
sudo mkdir /var/lib/vaultwarden/data
|
||||||
|
|
||||||
|
Correction des droits
|
||||||
|
|
||||||
|
sudo chmod +x /usr/bin/vaultwarden
|
||||||
|
sudo useradd -m -d /var/lib/vaultwarden vaultwarden
|
||||||
|
sudo chown -R vaultwarden:vaultwarden /var/lib/vaultwarden
|
||||||
|
|
||||||
|
### Création du fichier de service
|
||||||
|
|
||||||
|
On crée le fichier
|
||||||
|
|
||||||
|
sudo nano /etc/systemd/system/vaultwarden.service
|
||||||
|
|
||||||
|
Avec le contenu suivant :
|
||||||
|
|
||||||
```
|
```
|
||||||
cd existing_repo
|
[Unit]
|
||||||
git remote add origin https://git.a-lec.org/a-lec/commissions/infrastructure/service-coffre.git
|
Description=Bitwarden Server (Powered by Vaultwarden)
|
||||||
git branch -M main
|
Documentation=https://github.com/dani-garcia/vaultwarden
|
||||||
git push -uf origin main
|
# If you use a database like mariadb,mysql or postgresql,
|
||||||
|
# you have to add them like the following and uncomment them
|
||||||
|
# by removing the `# ` before it. This makes sure that your
|
||||||
|
# database server is started before vaultwarden ("After") and has
|
||||||
|
# started successfully before starting vaultwarden ("Requires").
|
||||||
|
|
||||||
|
|
||||||
|
# Only sqlite
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
# MariaDB
|
||||||
|
# After=network.target mariadb.service
|
||||||
|
# Requires=mariadb.service
|
||||||
|
|
||||||
|
# Mysql
|
||||||
|
# After=network.target mysqld.service
|
||||||
|
# Requires=mysqld.service
|
||||||
|
|
||||||
|
# PostgreSQL
|
||||||
|
# After=network.target postgresql.service
|
||||||
|
# Requires=postgresql.service
|
||||||
|
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
# The user/group vaultwarden is run under. the working directory (see below) should allow write and read access to this user/group
|
||||||
|
User=vaultwarden
|
||||||
|
Group=vaultwarden
|
||||||
|
# The location of the .env file for configuration
|
||||||
|
EnvironmentFile=/etc/vaultwarden.env
|
||||||
|
# The location of the compiled binary
|
||||||
|
ExecStart=/usr/bin/vaultwarden
|
||||||
|
# Set reasonable connection and process limits
|
||||||
|
LimitNOFILE=1048576
|
||||||
|
LimitNPROC=64
|
||||||
|
# Isolate vaultwarden from the rest of the system
|
||||||
|
PrivateTmp=true
|
||||||
|
PrivateDevices=true
|
||||||
|
ProtectHome=true
|
||||||
|
ProtectSystem=strict
|
||||||
|
# Only allow writes to the following directory and set it to the working directory (user and password data are stored here)
|
||||||
|
WorkingDirectory=/var/lib/vaultwarden
|
||||||
|
ReadWriteDirectories=/var/lib/vaultwarden
|
||||||
|
# Allow vaultwarden to bind ports in the range of 0-1024
|
||||||
|
AmbientCapabilities=CAP_NET_BIND_SERVICE
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
```
|
```
|
||||||
|
|
||||||
## Integrate with your tools
|
On recharge les services
|
||||||
|
|
||||||
- [ ] [Set up project integrations](https://git.a-lec.org/a-lec/commissions/infrastructure/service-coffre/-/settings/integrations)
|
sudo systemctl daemon-reload
|
||||||
|
|
||||||
## Collaborate with your team
|
On démarre
|
||||||
|
|
||||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
sudo systemctl start vaultwarden.service
|
||||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
sudo systemctl enable vaultwarden.service
|
||||||
- [ ] [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)
|
|
||||||
|
|
||||||
## Test and Deploy
|
|
||||||
|
|
||||||
Use the built-in continuous integration in GitLab.
|
|
||||||
|
|
||||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
## Mise à jour de Vaultwarden
|
||||||
- [ ] [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)
|
|
||||||
|
|
||||||
***
|
### Mise à jour de la chaîne de compilation rustup
|
||||||
|
|
||||||
# Editing this README
|
rustup update
|
||||||
|
|
||||||
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.
|
### Récupération des mises à jour
|
||||||
|
|
||||||
## Suggestions for a good README
|
On récupère les commits dans le dépôt et on passe sur le tag de la dernière version (`<version>`)
|
||||||
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.
|
|
||||||
|
|
||||||
## Name
|
cd ~/vaultwarden/vaultwarden
|
||||||
Choose a self-explaining name for your project.
|
git fetch
|
||||||
|
git checkout <version>
|
||||||
|
|
||||||
## Description
|
### Mise à jour du serveur
|
||||||
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.
|
|
||||||
|
|
||||||
## Badges
|
On compile avec rust le serveur, en nettoyant bien avant.
|
||||||
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.
|
|
||||||
|
|
||||||
## Visuals
|
cargo clean
|
||||||
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.
|
cargo build --features sqlite --release
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
## Usage
|
On installe le binaire
|
||||||
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.
|
|
||||||
|
|
||||||
## Support
|
sudo cp vaultwarden /usr/bin/vaultwarden
|
||||||
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.
|
sudo chmod +x /usr/bin/vaultwarden
|
||||||
|
|
||||||
## Roadmap
|
On redémarre le service
|
||||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
||||||
|
|
||||||
## Contributing
|
sudo systemctl restart vaultwarden.service
|
||||||
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.
|
## Installation de l'interface web
|
||||||
|
|
||||||
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.
|
### Installation des dépendances
|
||||||
|
|
||||||
## Authors and acknowledgment
|
On récupère la dernière version de npm/nodejs
|
||||||
Show your appreciation to those who have contributed to the project.
|
|
||||||
|
|
||||||
## License
|
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
|
||||||
For open source projects, say how it is licensed.
|
|
||||||
|
|
||||||
## Project status
|
On installe nodejs
|
||||||
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.
|
|
||||||
|
sudo apt-get install -y nodejs
|
||||||
|
npm -g install npm@7
|
||||||
|
npm i npm@latest -g
|
||||||
|
|
||||||
|
Ajout au `PATH`
|
||||||
|
|
||||||
|
echo 'export PATH=/opt/node/bin:$PATH' >> ~/.bashrc
|
||||||
|
|
||||||
|
## Mise à jour de l'interface web
|
||||||
|
|
||||||
|
### Récupération des mises à jour
|
||||||
|
|
||||||
|
On récupère les commits dans le dépôt
|
||||||
|
|
||||||
|
cd ~/vaultwarden/webvault
|
||||||
|
git fetch
|
||||||
|
|
||||||
|
### Compiler la dernière version de l'interface web
|
||||||
|
|
||||||
|
cd ~/vaultwarden/webvault
|
||||||
|
make full
|
||||||
|
|
||||||
|
Lorsque demandé, insérer l'identifiant du tag le plus récent (dispo avec git tag)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue