4NK
3f1894e21f
- Delete extensions/anythingllm-workspaces; document migration to anythingllm-devtools - Add services/carbonyl: shallow submodule fathyb/carbonyl, run-carbonyl.sh (Docker/native) - Add scripts/open-carbonyl-preview-test.sh and smart_ide.preview_urls.test in example conf - Docs: service-carbonyl, carbonyl-terminal-browser, architecture index updates
46 lines
2.2 KiB
Markdown
46 lines
2.2 KiB
Markdown
# carbonyl — navigateur terminal (amont)
|
||
|
||
[Carbonyl](https://github.com/fathyb/carbonyl) est un navigateur basé sur Chromium affiché dans le terminal (Web APIs, médias, utilisable sans serveur graphique, y compris via SSH).
|
||
|
||
Ce répertoire **`services/carbonyl/`** regroupe :
|
||
|
||
- **`upstream/`** : sous-module Git pointant vers le dépôt amont **fathyb/carbonyl** (fork / suivi des évolutions amont dans ce monorepo).
|
||
- **`run-carbonyl.sh`** : lancement via **Docker** (image publique `fathyb/carbonyl`) ou binaire **`carbonyl`** si installé (`npm install -g carbonyl`).
|
||
|
||
Ne pas exécuter **`git submodule update --init --recursive`** dans **`upstream/`** tant qu’un build Chromium complet n’est pas requis : le sous-module **chromium** amont est très volumineux. Pour un usage quotidien, préférer Docker ou le binaire précompilé.
|
||
|
||
## Prérequis
|
||
|
||
- **Docker** (recommandé) : `docker run --rm -ti fathyb/carbonyl https://example.com`
|
||
- ou dépendances **Chromium** sur l’hôte si build / binaire local — voir le [readme amont](https://github.com/fathyb/carbonyl/blob/main/readme.md).
|
||
|
||
## Variables (optionnelles)
|
||
|
||
| Variable | Rôle |
|
||
|----------|------|
|
||
| `CARBONYL_DOCKER_IMAGE` | Image Docker (défaut `fathyb/carbonyl`) |
|
||
| `CARBONYL_RUNNER` | `docker` (défaut) ou `native` pour appeler `carbonyl` dans le `PATH` |
|
||
|
||
## Scripts
|
||
|
||
- **`./run-carbonyl.sh <url>`** — ouvre l’URL dans Carbonyl.
|
||
- Depuis la racine du monorepo : **`scripts/open-carbonyl-preview-test.sh`** — ouvre l’URL **test** déclarée pour le projet actif (voir ci-dessous).
|
||
|
||
## Prévisualisation des déploiements **test**
|
||
|
||
Dans **`projects/<id>/conf.json`**, sous **`smart_ide`**, champ optionnel **`preview_urls`** :
|
||
|
||
```json
|
||
"preview_urls": {
|
||
"test": "https://app.example.test/"
|
||
}
|
||
```
|
||
|
||
Le script **`scripts/open-carbonyl-preview-test.sh`** lit **`projects/active-project.json`** (ou **`SMART_IDE_PROJECT_ID`**, ou argument **`--project <id>`**) puis **`preview_urls.test`**. En secours : variable **`PREVIEW_TEST_URL`**.
|
||
|
||
Documentation : [docs/repo/service-carbonyl.md](../../docs/repo/service-carbonyl.md), [docs/features/carbonyl-terminal-browser.md](../../docs/features/carbonyl-terminal-browser.md).
|
||
|
||
## Licence amont
|
||
|
||
Carbonyl est sous licence **BSD-3-Clause** (voir `upstream/license.md`).
|