File

mod_migrate/README.markdown @ 5519:83ebfc367169

mod_http_oauth2: Return Authentication Time per OpenID Core Section 2 Mandatory To Implement, either MUST include or OPTIONAL depending on things we don't look at, so might as well include it all the time. Since we do not persist authentication state with cookies or such, the authentication time will always be some point between the user being sent to the authorization endpoint and the time they are sent back to the client application.
author Kim Alvefur <zash@zash.se>
date Mon, 05 Jun 2023 22:32:44 +0200
parent 2970:c5122b7633a8
line wrap: on
line source

---
summary: prosodyctl cross storage driver migration tool
...

Introduction
============

This module adds a command to `prosodyctl` for copying data between
storage drivers.

Usage
=====

    prosodyctl mod_migrate example.com <source-store>[-<store-type>] <target-driver> [users]*

`<source-store>` would be e.g. `accounts` or `private`. To migrate
archives, the optional suffix `<store-type>` would be set to `archive`,
so e.g. `archive2-archive` or `muc_log-archive`. Multiple stores can be
given if separated by commas.

`<target-driver>` is the storage driver to copy data to, sans the
`mod_storage_` prefix.

`mod_migrate` tries to request a list of users from `usermanager`, but
this does not always work. If so, you can supply usernames as arguments
after the target driver.

The process is something like this:

1.  Decide on the future configuration and add for example SQL
    connection details to your prosody config, but don't change the
    `store` option yet.
2.  With Prosody shut down, run
    `prosodyctl mod_migrate example.com accounts sql`
3.  Repeat for each store, substituting 'accounts'. E.g. vcards,
    private...
4.  Change the [`storage` configuration](https://prosody.im/doc/storage)
    to use the new driver.
5.  Start prosody again.

Examples
========

``` sh
prosodyctl mod_migrate example.com accounts,roster,private,vcard sql
```

Compatibility
=============

Should work with 0.8 and later.