first commit

bastien70 · Aug 18, 2021 · f41655e · f41655e
commit f41655e
Show file tree

Hide file tree

Showing 79 changed files with 14,480 additions and 0 deletions.
diff --git a/.env b/.env
@@ -0,0 +1,41 @@
+# In all environments, the following files are loaded if they exist,
+# the latter taking precedence over the former:
+#
+#  * .env                contains default values for the environment variables needed by the app
+#  * .env.local          uncommitted file with local overrides
+#  * .env.$APP_ENV       committed environment-specific defaults
+#  * .env.$APP_ENV.local uncommitted environment-specific overrides
+#
+# Real environment variables win over .env files.
+#
+# DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
+#
+# Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
+# https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration
+
+###> symfony/framework-bundle ###
+APP_ENV=dev
+APP_SECRET=ed57093ff0c0f5c74d15b176f96d1e66
+###< symfony/framework-bundle ###
+
+###> symfony/mailer ###
+# MAILER_DSN=smtp://localhost
+###< symfony/mailer ###
+
+###> doctrine/doctrine-bundle ###
+# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
+# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
+#
+#DATABASE_URL="sqlite:///%kernel.project_dir%/var/dbsaver.db"
+DATABASE_URL="mysql://root:[email protected]:3306/dbsaver?serverVersion=5.7"
+#DATABASE_URL="postgresql://db_user:[email protected]:5432/db_name?serverVersion=13&charset=utf8"
+###< doctrine/doctrine-bundle ###
+
+###> AWS_S3 ###
+AWS_S3_ACCESS_ID="your aws_s3 access id"
+AWS_S3_ACCESS_SECRET="your aws_s3 access secret"
+AWS_S3_BUCKET_NAME="your aws_s3 bucket name"
+AWS_S3_REGION="eu-west-3"
+###< AWS S3 ###
+
+BACKUP_LOCAL=1
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,20 @@
+
+###> symfony/framework-bundle ###
+/.env.local
+/.env.local.php
+/.env.*.local
+/config/secrets/prod/prod.decrypt.private.php
+/public/bundles/
+/var/
+/vendor/
+###< symfony/framework-bundle ###
+
+###> symfony/phpunit-bridge ###
+.phpunit.result.cache
+/phpunit.xml
+###< symfony/phpunit-bridge ###
+
+###> phpunit/phpunit ###
+/phpunit.xml
+.phpunit.result.cache
+###< phpunit/phpunit ###
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Bastien Loughin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,163 @@
+# DbSaver
+
+![Alt text](./public/images/liste_bases.png?raw=true "Liste des bases de données")
+
+DbSaver est une application réalisée par <b>Bastien LOUGHIN</b>, vous permettant de réaliser des backups quotidiens automatiques (et manuels) pour vos bases de données MySQL.
+Vous n'avez qu'à renseigner les identifiants pour accéder aux différentes bases de données, configurer une tâche CRON... et c'est fini.
+Les mots de passe seront automatiquement cryptés.
+
+Vous pourrez ensuite grâce à DbSaver accéder aux différents backups de vos bases de données en vous rendant sur l'onglet <b>Backups</b>.
+Ceux-ci peuvent être sauvegardés en <b>local</b> ou sur le cloud d'Amazon <b>AWS S3</b>.
+
+/!\ DbSaver sauvegarde uniquement les données stockées dans les bases de données. Les fichiers (uploads clients par exemple) ne sont pas sauvegardés.
+
+# Table des matières
+
+1. [Pré-requis](#preRequis)
+2. [Installation](#installation)
+3. [Configuration de la tâche CRON](#cron)
+4. [Backups en local ou sur AWS S3](#backups)
+    1. [Local](#backupLocal)
+    2. [AWS S3](#backupAws)
+5. [Utiliser l'application](#app)
+6. [Licence](#licence)
+
+
+## Pré-requis <a name="preRequis"></a>
+
+* PHP 8
+* Composer
+* Symfony CLI (si vous souhaitez lancer le projet en local)
+
+## Installation <a name="installation"></a>
+
+1. `git clone [email protected]:bastien70/dbsaver.git`
+2. `cd dbsaver`
+3. Configurez la variable d'environnement dans le fichier `.env` : `DATABASE_URL`.
+3. `composer install` (installation des dépendances)
+4. `php bin/console app:regenerate-app-secret` (régénération de la clé secrète permettant de crypter les mots de passes de vos bases de données)
+5. `php bin/console d:d:c` (création de la base de données)
+6. `php bin/console d:s:u -f` (migration des tables)
+7. `php bin/console app:make-user` (création de votre compte d'accès)
+
+## Configuration de la tâche CRON <a name="cron"></a>
+
+Configurer une tâche CRON vous servira à lancer automatiquement et à la fréquence désirée, un backup de toutes vos bases de données.
+
+Le fichier responsable de lancer la commande se trouve sur `[projet]/src/Command/BackupCommand.php`
+
+La commande à effectuer pour la lancer est la suivante : `php bin/console app:backup`
+
+Initialisez une tâche CRON sur votre serveur ou PC :
+
+`[chemin vers php] [chemin vers la racine du projet]/bin/console app:backup`
+
+## Backups en local ou sur AWS S3 <a name="backups"></a>
+
+### Local <a name="backupLocal"></a>
+
+L'application est configurée pour sauvegarder les backups en local. Si vous venez d'installer l'application, vous n'avez rien à faire.
+Sinon, voici les changements à effectuer :
+
+Ouvrez le fichier `[projet]/config/packages/vich_uploader.yaml`.
+
+Remplacez le contenu par :
+
+```yaml
+### UTILISEZ CETTE CONFIGURATION SI VOUS SOUHAITEZ STOCKER LES FICHIERS EN LOCAL ###
+vich_uploader:
+    db_driver: orm
+    mappings:
+        backups:
+            uri_prefix: /files/backups
+            upload_destination: '%kernel.project_dir%/public/files/backups'
+
+
+### UTILISEZ CETTE CONFIGURATION SI VOUS SOUHAITEZ STOCKER LES FICHIERS SUR LE CLOUD AWS S3
+#vich_uploader:
+#    db_driver: orm
+#    storage: gaufrette
+#    mappings:
+#        backups:
+#            uri_prefix: '%uploads_base_url%'
+#            upload_destination: backup_fs
+```
+
+Modifiez également la variable d'environnement `BACKUP_LOCAL` dans le fichier `.env` comme ceci :
+`BACKUP_LOCAL=1`
+
+### AWS S3 <a name="backupAws"></a>
+
+Modifiez dans le fichier `.env` les variables d'environnement suivantes pour les faire correspondre à ceux renseignés par AWS S3.
+
+```
+###> AWS_S3 ###
+AWS_S3_ACCESS_ID="your aws_s3 access id"
+AWS_S3_ACCESS_SECRET="your aws_s3 access secret"
+AWS_S3_BUCKET_NAME="your aws_s3 bucket name"
+AWS_S3_REGION="eu-west-3"
+###< AWS S3 ###
+```
+
+Modifiez également la variable `BACKUP_LOCAL` comme ceci :
+`BACKUP_LOCAL=0`
+
+Ouvrez le fichier `[projet]/config/packages/vich_uploader.yaml`.
+
+Remplacez le contenu par :
+
+```yaml
+### UTILISEZ CETTE CONFIGURATION SI VOUS SOUHAITEZ STOCKER LES FICHIERS EN LOCAL ###
+#vich_uploader:
+#    db_driver: orm
+#    mappings:
+#        backups:
+#            uri_prefix: /files/backups
+#            upload_destination: '%kernel.project_dir%/public/files/backups'
+
+
+### UTILISEZ CETTE CONFIGURATION SI VOUS SOUHAITEZ STOCKER LES FICHIERS SUR LE CLOUD AWS S3
+vich_uploader:
+    db_driver: orm
+    storage: gaufrette
+    mappings:
+        backups:
+            uri_prefix: '%uploads_base_url%'
+            upload_destination: backup_fs
+```
+
+## Utiliser l'application <a name="app"></a>
+
+Après avoir déployé l'application sur votre serveur (ou l'avoir lancée en local), accédez à la page de connexion :
+Pour l'exemple, le nom de domaine rattaché à l'application sera `127.0.0.1:8000`.
+
+Lancez l'application : `https://127.0.0.1:8000`
+Vous serez invité à vous connecter. Entrez les identifiants de votre compte (que vous avez créé avec la commande `php bin/console app:make-user`)
+
+![Alt text](./public/images/authentification.png?raw=true "Authentification")
+
+Vous serez redirigés vers `https://127.0.0.1:8000/dbsaver`
+
+![Alt text](./public/images/accueil.png?raw=true "Accueil")
+
+Pour créer une base de données, cliquez sur l'onglet `Bases de données`, puis sur le bouton `Ajouter une base de données`.
+Remplissez les informations de votre base de données et validez.
+
+![Alt text](./public/images/creer_base.png?raw=true "Ajouter une base de données")
+
+Vous aurez dès lors, pour chaque base de données ajoutée, la possibilité de consulter les backups, d'éditer les informations de la base de données,
+supprimer la base de données de l'application (ainsi que ses backups),ou lancer un backup manuel.
+
+![Alt text](./public/images/liste_bases.png?raw=true "Liste des bases de données")
+
+Selon la fréquence de votre tâche CRON que vous avez configurée, un backup automatique sera effectué.
+
+Pour accéder aux backups de vos bases, cliquez sur l'onglet `Backups`.
+
+![Alt text](./public/images/liste_backups.png?raw=true "Liste des backups")
+
+Vous aurez la possibilité de supprimer ou télécharger un Backup.
+
+## Licence <a name="licence"></a>
+
+Cette application est protégée par une licence MIT : [LICENCE](LICENSE)
diff --git a/bin/console b/bin/console
@@ -0,0 +1,17 @@
+#!/usr/bin/env php
+<?php
+
+use App\Kernel;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+
+if (!is_file(dirname(__DIR__).'/vendor/autoload_runtime.php')) {
+    throw new LogicException('Symfony Runtime is missing. Try running "composer require symfony/runtime".');
+}
+
+require_once dirname(__DIR__).'/vendor/autoload_runtime.php';
+
+return function (array $context) {
+    $kernel = new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);
+
+    return new Application($kernel);
+};
diff --git a/bin/phpunit b/bin/phpunit
@@ -0,0 +1,19 @@
+#!/usr/bin/env php
+<?php
+
+if (!ini_get('date.timezone')) {
+    ini_set('date.timezone', 'UTC');
+}
+
+if (is_file(dirname(__DIR__).'/vendor/phpunit/phpunit/phpunit')) {
+    define('PHPUNIT_COMPOSER_INSTALL', dirname(__DIR__).'/vendor/autoload.php');
+    require PHPUNIT_COMPOSER_INSTALL;
+    PHPUnit\TextUI\Command::main();
+} else {
+    if (!is_file(dirname(__DIR__).'/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php')) {
+        echo "Unable to find the `simple-phpunit.php` script in `vendor/symfony/phpunit-bridge/bin/`.\n";
+        exit(1);
+    }
+
+    require dirname(__DIR__).'/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php';
+}
diff --git a/composer.json b/composer.json
@@ -0,0 +1,106 @@
+{
+    "type": "project",
+    "license": "proprietary",
+    "minimum-stability": "stable",
+    "prefer-stable": true,
+    "require": {
+        "php": ">=8.0",
+        "ext-ctype": "*",
+        "ext-iconv": "*",
+        "aws/aws-sdk-php": "^3.190",
+        "composer/package-versions-deprecated": "1.11.99.2",
+        "doctrine/annotations": "^1.0",
+        "doctrine/doctrine-bundle": "^2.4",
+        "doctrine/doctrine-migrations-bundle": "^3.1",
+        "doctrine/orm": "^2.9",
+        "easycorp/easyadmin-bundle": "^3.5",
+        "ifsnop/mysqldump-php": "^2.9",
+        "knplabs/knp-gaufrette-bundle": "^0.7.1",
+        "nzo/url-encryptor-bundle": "^6.0",
+        "phpdocumentor/reflection-docblock": "^5.2",
+        "sensio/framework-extra-bundle": "^6.1",
+        "symfony/asset": "5.3.*",
+        "symfony/console": "5.3.*",
+        "symfony/dotenv": "5.3.*",
+        "symfony/expression-language": "5.3.*",
+        "symfony/flex": "^1.3.1",
+        "symfony/form": "5.3.*",
+        "symfony/framework-bundle": "5.3.*",
+        "symfony/http-client": "5.3.*",
+        "symfony/intl": "5.3.*",
+        "symfony/mailer": "5.3.*",
+        "symfony/mime": "5.3.*",
+        "symfony/monolog-bundle": "^3.1",
+        "symfony/notifier": "5.3.*",
+        "symfony/process": "5.3.*",
+        "symfony/property-access": "5.3.*",
+        "symfony/property-info": "5.3.*",
+        "symfony/proxy-manager-bridge": "5.3.*",
+        "symfony/runtime": "5.3.*",
+        "symfony/security-bundle": "5.3.*",
+        "symfony/serializer": "5.3.*",
+        "symfony/string": "5.3.*",
+        "symfony/translation": "5.3.*",
+        "symfony/twig-bundle": "^5.3",
+        "symfony/validator": "5.3.*",
+        "symfony/web-link": "5.3.*",
+        "symfony/yaml": "5.3.*",
+        "twig/extra-bundle": "^2.12|^3.0",
+        "twig/twig": "^2.12|^3.0",
+        "vich/uploader-bundle": "^1.18"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.5",
+        "symfony/browser-kit": "^5.3",
+        "symfony/css-selector": "^5.3",
+        "symfony/debug-bundle": "^5.3",
+        "symfony/maker-bundle": "^1.0",
+        "symfony/phpunit-bridge": "^5.3",
+        "symfony/stopwatch": "^5.3",
+        "symfony/var-dumper": "^5.3",
+        "symfony/web-profiler-bundle": "^5.3"
+    },
+    "config": {
+        "optimize-autoloader": true,
+        "preferred-install": {
+            "*": "dist"
+        },
+        "sort-packages": true
+    },
+    "autoload": {
+        "psr-4": {
+            "App\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "App\\Tests\\": "tests/"
+        }
+    },
+    "replace": {
+        "symfony/polyfill-ctype": "*",
+        "symfony/polyfill-iconv": "*",
+        "symfony/polyfill-php72": "*"
+    },
+    "scripts": {
+        "auto-scripts": {
+            "cache:clear": "symfony-cmd",
+            "assets:install %PUBLIC_DIR%": "symfony-cmd"
+        },
+        "post-install-cmd": [
+            "@auto-scripts"
+        ],
+        "post-update-cmd": [
+            "@auto-scripts"
+        ]
+    },
+    "conflict": {
+        "symfony/symfony": "*"
+    },
+    "extra": {
+        "symfony": {
+            "allow-contrib": false,
+            "require": "5.3.*"
+        }
+    }
+}