Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Commit

Permalink
Docs(deploy): Update docker-compose command in installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
LimeDrive committed Sep 28, 2024
1 parent f96c91c commit 7d096e0
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 29 deletions.
4 changes: 3 additions & 1 deletion docs/DOCS_VERSION
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ To push docs deployment action commit must start with `Docs(deploy):` prefix and
## v1.0.2
- Fix: ...
## v1.0.3
- Fix: language switcher
- Fix: language switcher
## v1.0.4
- Fix: docker-compose cmd
18 changes: 9 additions & 9 deletions docs/en/StreamFusion/docker_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,13 @@ The following table details each environment variable:
Once the `docker-compose.yml` and `.env` files are configured, launch the stack:

```bash
docker-compose up -d
docker compose up -d
```

Verify that all containers are running:

```bash
docker-compose ps
docker compose ps
```

!!! note "Initialization and configuration"
Expand All @@ -128,7 +128,7 @@ docker-compose ps
!!! tip "Monitoring initialization"
You can follow the initialization process in real-time with the command:
```bash
docker-compose logs -f zilean
docker compose logs -f zilean
```

## Updating and management
Expand All @@ -141,12 +141,12 @@ To update StreamFusion containers:

1. Pull the latest images:
```bash
docker-compose pull
docker compose pull
```

2. Restart the containers with the new images:
```bash
docker-compose up -d
docker compose up -d
```

!!! info "Update frequency"
Expand All @@ -156,9 +156,9 @@ To update StreamFusion containers:

Useful commands for managing your installation:

- **Stop the stack**: `docker-compose down`
- **View logs**: `docker-compose logs -f [service_name]`
- **Restart a specific service**: `docker-compose restart [service_name]`
- **Stop the stack**: `docker compose down`
- **View logs**: `docker compose logs -f [service_name]`
- **Restart a specific service**: `docker compose restart [service_name]`

!!! tip "Backup"
Remember to regularly backup your `docker-compose.yml` and `.env` files, as well as Docker volumes if you want to preserve your data. You can automate this process with a backup script.
Expand All @@ -169,7 +169,7 @@ Useful commands for managing your installation:
BACKUP_DIR="/path/to/backups"
mkdir -p $BACKUP_DIR
cp docker-compose.yml .env $BACKUP_DIR
docker-compose exec postgres pg_dump -U postgres > $BACKUP_DIR/database_backup.sql
docker compose exec postgres pg_dump -U postgres > $BACKUP_DIR/database_backup.sql
```

By following these instructions, you will have a robust and well-managed installation of StreamFusion. Don't hesitate to consult the documentation for more advanced configurations or optimizations specific to your use case.
3 changes: 3 additions & 0 deletions docs/en/StreamFusion/post_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The first step is to access the StreamFusion admin panel to perform the initial
```
https://your-domain.com/api/admin
```

!!! note "Custom URL"
Replace `your-domain.com` with the domain you've configured for StreamFusion.

Expand All @@ -25,6 +26,7 @@ Once logged into the admin panel, you need to create an API key for each StreamF

1. Click on "New API Key" or a similar button.
2. Fill in the required information:

- User's name
- Select "never expire" for the key's validity duration

Expand All @@ -44,6 +46,7 @@ After obtaining a user API key, you can proceed with configuring the StreamFusio
```
2. You'll be directed to the StreamFusion configuration page.
3. Fill in the requested information:

- User API key (the one you just created)
- Other parameters according to your preferences

Expand Down
4 changes: 2 additions & 2 deletions docs/en/StreamFusion/proxy_npm.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ networks:
Start Nginx Proxy Manager with the following command:
```bash
docker-compose up -d
docker compose up -d
```
## Configuring Nginx Proxy Manager
Expand Down Expand Up @@ -208,7 +208,7 @@ Once you've completed the reverse proxy configuration and verified that everythi
After modifying the file, restart the container to apply the changes:

```bash
docker-compose up -d
docker compose up -d
```

!!! warning "Accessing the Admin Interface"
Expand Down
18 changes: 9 additions & 9 deletions docs/fr/StreamFusion/docker_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,13 @@ Le tableau suivant détaille chaque variable d'environnement :
Une fois les fichiers `docker-compose.yml` et `.env` configurés, lancez la stack :

```bash
docker-compose up -d
docker compose up -d
```

Vérifiez que tous les conteneurs sont en cours d'exécution :

```bash
docker-compose ps
docker compose ps
```

!!! note "Initialisation et configuration"
Expand All @@ -128,7 +128,7 @@ docker-compose ps
!!! tip "Suivi de l'initialisation"
Vous pouvez suivre le processus d'initialisation en temps réel avec la commande :
```bash
docker-compose logs -f zilean
docker compose logs -f zilean
```

## Mise à jour et gestion
Expand All @@ -141,12 +141,12 @@ Pour mettre à jour les conteneurs de StreamFusion :

1. Tirez les dernières images :
```bash
docker-compose pull
docker compose pull
```

2. Redémarrez les conteneurs avec les nouvelles images :
```bash
docker-compose up -d
docker compose up -d
```

!!! info "Fréquence des mises à jour"
Expand All @@ -156,9 +156,9 @@ Pour mettre à jour les conteneurs de StreamFusion :

Commandes utiles pour gérer votre installation :

- **Arrêter la stack** : `docker-compose down`
- **Voir les logs** : `docker-compose logs -f [nom_du_service]`
- **Redémarrer un service spécifique** : `docker-compose restart [nom_du_service]`
- **Arrêter la stack** : `docker compose down`
- **Voir les logs** : `docker compose logs -f [nom_du_service]`
- **Redémarrer un service spécifique** : `docker compose restart [nom_du_service]`

!!! tip "Sauvegarde"
Pensez à sauvegarder régulièrement vos fichiers `docker-compose.yml` et `.env`, ainsi que les volumes Docker si vous souhaitez conserver vos données. Vous pouvez automatiser ce processus avec un script de sauvegarde.
Expand All @@ -169,7 +169,7 @@ Commandes utiles pour gérer votre installation :
BACKUP_DIR="/chemin/vers/backups"
mkdir -p $BACKUP_DIR
cp docker-compose.yml .env $BACKUP_DIR
docker-compose exec postgres pg_dump -U postgres > $BACKUP_DIR/database_backup.sql
docker compose exec postgres pg_dump -U postgres > $BACKUP_DIR/database_backup.sql
```

En suivant ces instructions, vous aurez une installation robuste et bien gérée de StreamFusion. N'hésitez pas à consulter la documentation pour des configurations plus avancées ou des optimisations spécifiques à votre cas d'utilisation.
9 changes: 6 additions & 3 deletions docs/fr/StreamFusion/post_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ La première étape consiste à accéder au panel d'administration de StreamFusi

1. Ouvrez votre navigateur web préféré.
2. Naviguez vers l'URL suivante :
```
https://votre-domaine.com/api/admin
```
```
https://votre-domaine.com/api/admin
```

!!! note "URL personnalisée"
Remplacez `votre-domaine.com` par le domaine que vous avez configuré pour StreamFusion.

Expand All @@ -25,6 +26,7 @@ Une fois connecté au panel d'administration, vous devez créer une clé API pou

1. Cliquez sur "New API Key" ou un bouton similaire.
2. Remplissez les informations requises :

- Nom de l'utilisateur
- Sélectionnez "never expire" pour la durée de validité de la clé

Expand All @@ -45,6 +47,7 @@ Après avoir obtenu une clé API utilisateur, vous pouvez procéder à la config
```
2. Vous serez dirigé vers la page de configuration de StreamFusion.
3. Remplissez les informations demandées :

- Clé API utilisateur (celle que vous venez de créer)
- Autres paramètres selon vos préférences

Expand Down
4 changes: 2 additions & 2 deletions docs/fr/StreamFusion/proxy_npm.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ networks:
Démarrez Nginx Proxy Manager avec la commande suivante :
```bash
docker-compose up -d
docker compose up -d
```
## Configuration de Nginx Proxy Manager
Expand Down Expand Up @@ -209,7 +209,7 @@ Une fois que vous avez terminé la configuration du reverse proxy et vérifié q
Après avoir modifié le fichier, redémarrez le conteneur pour appliquer les changements :
```bash
docker-compose up -d
docker compose up -d
```
!!! warning "Accès à l'interface d'administration"
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "stream-fusion"
version = "2.0.0"
version = "2.0.2"
description = "StreamFusion is an advanced plugin for Stremio that significantly enhances its streaming capabilities with debrid service."
authors = ["LimeDrive <[email protected]>"]
readme = "README.md"
Expand Down
4 changes: 2 additions & 2 deletions stream_fusion/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,10 @@ class Settings(BaseSettings):
public_cache_url: str = "https://stremio-jackett-cacher.elfhosted.com/"

# DEVELOPMENT
debug: bool = True
debug: bool = False
dev_host: str = "0.0.0.0"
dev_port: int = 8080
develop: bool = True
develop: bool = False
reload: bool = False

@property
Expand Down

0 comments on commit 7d096e0

Please sign in to comment.