doc/Migrate.md

   1 Migrating to a new server installation
   2 ===============
   3
   4 * [Home](help)
   5
   6 ## Preparation
   7
   8 ### New server
   9 Set up your new server as described [here](Install); follow the installation procedure until you have created a database.
  10
  11 ### Heads up to users
  12 Inform your users of an upcoming interruption to your service.
  13 To ensure data consistency, your server needs to be offline during some steps of the migration processes.
  14
  15 You may also find these addons useful for communicating with your users prior to the migration process:
  16 * blackout
  17 * notifyall
  18
  19 ### Storage
  20 Check your storage backend with ``bin/console storage list`` in the root folder.
  21 The output should look like this:
  22 ````
  23 Sel | Name
  24 -----------------------
  25      | Filesystem
  26  *   | Database
  27 ````
  28
  29 If you are *not* using ``Database`` run the following commands:
  30 1.  ``bin/console storage set Database`` to activate the database backend.
  31 2.  ``bin/console storage move`` to initiate moving the stored image files.
  32
  33 This process may take a long time depending on the size of your storage and your server's capacity.
  34 Prior to initiating this process, you may want to check the number of files in the storage with the following command: ``tree -if -I index.html /path/to/storage/``.
  35
  36 ### Cleaning up
  37 Before transferring your database, you may want to clean it up; ensure the expiration of database items is set to a reasonable value and activated via the administrator panel.
  38 *Admin* > *Site* > *Performance* > Enable "Clean up database"
  39 After adjusting these settings, the database cleaning up processes will be initiated according to your configured daily cron job.
  40
  41 To review the size of your database, log into MySQL with ``mysql -p`` run the following query:
  42 ````
  43 SELECT table_schema AS "Database", SUM(data_length + index_length) / 1024 / 1024 / 1024 AS "Size (GB)" FROM information_schema.TABLES GROUP BY table_schema;
  44 ````
  45
  46 You should see an output like this:
  47 ````
  48 +--------------------+----------------+
  49 | Database           | Size (GB)      |
  50 +--------------------+----------------+
  51 | friendica_db       | 8.054092407227 |
  52 | [..........]       | [...........]  |
  53 +--------------------+----------------+
  54 ````
  55
  56 Finally, you may also want to optimise your database with the following command: ``mysqloptimize -p friendica-db``
  57
  58 ### Going offline
  59 Stop background tasks and put your server in maintenance mode.
  60 1.  If you had set up a worker cron job like this ``*/10 * * * * cd /var/www/friendica; /usr/bin/php bin/worker.php`` run ``crontab -e`` and comment out this line. Alternatively if you deploy a worker daemon, disable this instead.
  61 2.  Put your server into maintenance mode: ``bin/console maintenance 1 "We are currently upgrading our system and will be back soon."``
  62
  63 ## Dumping DB
  64 Export your database: ``mysqldump  -p friendica_db > friendica_db-$(date +%Y%m%d).sql`` and possibly compress it.
  65
  66 ## Transferring to new server
  67 Transfer your database and a copy of your configuration file ``config/local.config.php.copy`` to your new server installation.
  68
  69 ## Restoring your DB
  70 Import your database on your new server: ``mysql -p friendica_db < your-friendica_db-file.sql``
  71
  72 ## Completing migration
  73
  74 ### Configuration file
  75 Copy your old server's configuration file to ``config/local.config.php``.
  76 Ensure the newly created database credentials are identical to the setting in the configuration file; otherwise update them accordingly.
  77
  78 ### Cron job for worker
  79 Set up the required daily cron job.
  80 Run ``crontab -e`` and add the following line according to your system specification
  81 ``*/10 * * * * cd /var/www/friendica; /usr/bin/php bin/worker.php``
  82
  83 ### DNS settings
  84 Adjust your DNS records by pointing them to your new server.
  85
  86 ## Troubleshooting
  87 If you are unable to login to your newly migrated Friendica installation, check your web server's error and access logs and mysql logs for obvious issues.
  88
  89 If still unable to resolve the problem, it's likely an issue with your [installation](Install).
  90 In this case, you may try to an entirely new Friendica installation on your new server, but use a different FQDN and DNS name.
  91 Once you have this up and running, take it offline and purge the database and configuration file and try migrating to this installation.
  92