Skip to content
Extraits de code Groupes Projets
Valider a1ba8fd7 rédigé par nicod's avatar nicod
Parcourir les fichiers

docs: Ajout des docs d'installation et d'utilisation.

On supprime la version anglaise, pénible à mettre à jour pour le peu d'utilité (si tant est qu'il y en ait une même).
On ne ferme par #2, il pourrait y avoir d'autres propositions.

Ref #2
parent e02b02c5
Aucune branche associée trouvée
Aucune étiquette associée trouvée
1 requête de fusion!5docs: Ajout des docs d'installation et d'utilisation.
(english below)
# Intégration de spip-cli et checkout à DDEV
# [fr] Intégration de spip-cli et checkout à DDEV
DDEV est une couche d'abstraction à docker et docker-compose qui permet de mettre en place rapidement des environnements de développement avec de multiples versions de PHP, de Mysql, avec Apache ou Nginx, sans avoir rien installer ou modifier sur la machine hôte.
DDEV est une couche d'abstraction à docker et docker-compose qui permet de mettre en place
rapidement des environnements de développement avec de multiples versions de PHP, de Mysql
ou MariaDb, avec Apache ou Nginx, et sans avoir rien installer ou modifier sur la machine hôte.
https://ddev.readthedocs.io
Ce script permet d'intégrer [spip-cli](https://contrib.spip.net/SPIP-Cli) et [checkout](https://git.spip.net/spip-contrib-outils/checkout) parmi les outils disponibles (comme composer, drush, artisan, wp-cli), pour l'installer dans le conteneur et interagir avec le SPIP qui y est installé.
Ils fonctionneront alors avec la version de PHP du conteneur, et pas avec celle de la machine hôte.
## 1/ Installation
- pour une utilisation globale pour tous les projets, copier les fichiers `spip` et `checkout` de ce dépôt dans `~/.ddev/commands/web`
- ou bien, pour une utilisation par projet, les copier simplement dans votre projet : `/var/www/html/nom_du_site/.ddev/commands/web`
puis redémarrer le site pour pouvoir les utiliser : `ddev restart nom_du_site`.
Si tout est ok, vous devez les voir dans la liste des commandes disponibles avec `ddev -h`.
## 2/ Utilisation
Il suffit de lancer une première fois `ddev spip` ou `ddev checkout`, qui vous proposera de les installer, puis de les utiliser avec les commandes habituelles, par exemple : `ddev spip dl` ou `ddev checkout spip .`
En cas de restart du conteneur, les fichiers de son système sont écrasés, il faut donc relancer l'installation.
# [en] Integration of spip-cli and checkout with DDEV
DDEV is an abstraction layer to docker and docker-compose that allows to quickly set up development environments with multiple versions of PHP, Mysql, with Apache or Nginx, without having to install or modify anything on the host machine.
https://ddev.readthedocs.io
This script allows you to integrate [spip-cli](https://contrib.spip.net/SPIP-Cli) and [checkout](https://git.spip.net/spip-contrib-outils/checkout) with the available tools (such as composer, drush, artisan, wp-cli), to install it in the container and interact with the SPIP installed there.
spip-cli and checkout will then work with the version of PHP in the container, and not with the version on the host machine.
## 1/ Installation
- for global use for all projects, copy the files `spip` and `checkout` into `~/.ddev/commands/web`
- or, for a use per project, simply copy these in `/var/www/html/site_name/.ddev/commands/web`
then restart the project to be able to use it : `ddev restart site_name`.
If everything is ok, you should see them in the list of available commands with `ddev -h`.
Ce script permet d'intégrer [spip-cli](https://contrib.spip.net/SPIP-Cli) et [checkout](https://git.spip.net/spip-contrib-outils/checkout) parmi les outils disponibles
(comme composer, drush, artisan, wp-cli), pour les installer dans le conteneur et interagir
avec le SPIP qui y est installé.
## 2/ Use
Ils fonctionneront alors avec la version de PHP du conteneur, et pas avec celle de la machine
hôte.
You just have to run `ddev spip` or `ddev checkout` once, which will propose you to install it, then use it with the usual commands, for example : `ddev spip dl` or `ddev checkout spip .`
Quelques liens de documentation :
If the container is restarted, its system files will be overwritten, so you will have to restart the installation.
1. [Installation](docs/10-INSTALL)
2. [SPIPer avec DDEV](docs/20-SPIP_DDEV)
3. [Utiliser ses clés SSH](docs/30-SSH)
\ No newline at end of file
# Installation de spip-cli et checkout dans DDEV
## Méthode 1
### 1/ Installation
- pour une utilisation globale pour tous les projets, copier les fichiers `spip` et `checkout` à la racine de ce dépôt dans `~/.ddev/commands/web`
- ou bien, pour une utilisation par projet, les copier simplement dans votre projet : `/var/www/html/nom_du_site/.ddev/commands/web`
puis redémarrer le site pour pouvoir les utiliser : `ddev restart nom_du_site`.
Si tout est ok, vous devez les voir dans la liste des commandes disponibles avec `ddev -h`.
### 2/ Utilisation
Il suffit de lancer une première fois `ddev spip` ou `ddev checkout`, qui vous proposera de
les installer, puis de les utiliser avec les commandes habituelles, par exemple : `ddev spip dl`
ou `ddev checkout spip .`
En cas de restart du conteneur, les fichiers de son système sont écrasés, il faut donc
relancer l'installation.
## Méthode 2
Proposée par @marcimat, qui s'agaçait que DDEV doive réinstaller spip-cli (git clone) à chaque
fois qu’on restart un projet…
Alors il a changé de méthode : installer par défaut dans homeadditions, et appeller ces scripts
dans les commandes webs.
### spip-cli
```shell
cd ~/.ddev/homeadditions
git clone git@git.spip.net:spip-contrib-outils/spip-cli.git
cd spip-cli
composer install --no-dev
```
```shell
cd ~/.ddev/commands/web
echo '#!/bin/bash' > spip
echo '~/spip-cli/bin/spip "$@"' >> spip
```
### checkout
Piège : DDEV n'aime pas trop les liens symboliques…
```shell
cd ~/.ddev/homeadditions
git clone git@git.spip.net:spip-contrib-outils/checkout.git
# DDEV aime pas le lien symbolique checkout -> checkout.php
rm checkout/checkout
```
```shell
cd ~/.ddev/commands/web
echo '#!/bin/bash' > checkout
echo '~/checkout/checkout.php "$@"' >> checkout
```
Évidemment dans ce cas là, c’est à vous de faire les mises à jour (git pull / composer install)
de `spip-cli` et `checkout`de temps en temps.
# Utilisation de SPIP avec DDEV
Bricebou a écrit deux articles qui expliquent comment installer un SPIP dans un conteneur DDEV :
[SPIPer avec DDEV](https://momh.fr/spiper-avec-ddev)
[SPIPer avec DDEV bis](https://momh.fr/spiper-avec-ddev-bis)
# Gestion des clés SSH avec DDEV
Pour cloner depuis git.spip.net puis pusher ses PR, et si bien sûr vous y avez enregistré vos clés,
il est plus pratique d'utiliser SSH (c'est à dire, commencer par cloner sous la forme
`git clone git@git.spip.net:...`)
**Problème :** le conteneur DDEV (et donc, docker), ne connait pas vos clés ssh, celles de l'hôte.
Il suffit simplement de lancer `ddev auth ssh` dans le terminal de votre conteneur DDEV
et de saisir votre passphrase, pour que le conteneur puisse interagir avec vos clés ssh,
qui seront chargées dans l'agent en mémoire.
Ce sera effectif jusqu'au prochain reboot.
**Nouveau problème :** parfois on a de nombreuses paires de clés ssh.
Cette discussion propose deux façons de contourner le problème :
https://stackoverflow.com/questions/61485061/when-i-try-to-use-ssh-in-ddev-web-container-after-ddev-auth-ssh-the-ssh-keys
\ No newline at end of file
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter