WEBDIENSTE/huly-selfhost
1
0
Fork 0
mirror of https://github.com/hcengineering/huly-selfhost.git synced 2026-08-17 21:25:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
huly-selfhost/MIGRATION.md
T
Artyom SavchenkoandGitHub e8c0350368 Update to version 0.7.426 (#308) 
Signed-off-by: Artem Savchenko <armisav@gmail.com>
2026-07-04 22:23:20 +07:00

291 lines
7.9 KiB
Markdown
Raw Permalink Blame History

# Huly Migration
This document describes the changes required to update Huly from one version to another. Most of updates require updating Docker containers versions.
Though, some updates may require updating other configuration options. In this case, you should review the updated configuration options and update them accordingly.
> [!TIP]
> If you use the desktop app and want it to upgrade from Huly distributions keep DESKTOP_CHANNEL in sync with the version of the containers without "v" prefix.
## v0.7
WARNING: if you are migrating from v6 see [v0.7.204](#v07204) for details.
> [!CAUTION]
> Do not upgrade directly from v6 to v7. Direct upgrades will lock your deployment with MongoDB-specific data, making the future migration significantly more complex. Follow the migration instructions below instead.
### v0.7.426
No changes required.
### v0.7.423
#### Print Service
`FRONT_URL` is now required for the `print` service. If you have the optional `print` service deployed, add `FRONT_URL` to its environment:
```yaml
print:
...
environment:
...
- FRONT_URL=http${SECURE:+s}://${HOST_ADDRESS}
```
After updating, recreate the container:
```bash
docker compose up -d --force-recreate print
```
### v0.7.382
No changes required.
### v0.7.375
No changes required.
### v0.7.353
No changes required.
### v0.7.350
No changes required.
### v0.7.342
No changes required.
### v0.7.314
No changes required.
### v0.7.311
No changes required.
### v0.7.310
No changes required.
### v0.7.242
No changes required.
### v0.7.235
No changes required.
### v0.7.204
> [!WARNING]
> Use of MongoDB has been deprecated in v7 in favor of CockroachDB and will be completely removed in v8.
Migration to v7 involves backing up your v6 deployment data and restoring it to a fresh v7 installation with CockroachDB.
Migration Steps (command examples shown for Docker on macOS):
1. Make a full backup of your v6 deployment. Run the following command on **v6** tag of the `huly-selfhost` repository adjusting the variables to the actual values of your deployment in case they differ from the ones in the sample deployment.
```
source .env && docker run \
--network "${DOCKER_NAME}_default" \
-e SERVER_SECRET="$SECRET" \
-e TRANSACTOR_URL="ws://transactor:3333" \
-e STORAGE_CONFIG="minio|minio?accessKey=minioadmin&secretKey=minioadmin" \
-e ACCOUNT_DB_URL="mongodb://mongodb:27017" \
-e ACCOUNTS_URL="http://account:3000" \
-e DB_URL="mongodb://mongodb:27017" \
-v ./backup-all:/backup \
-it hardcoreeng/tool:v0.6.504 \
-- bundle.js backup-all-to-dir /backup \
--internal true \
--blobLimit 4096
```
> [!NOTE]
> This command will write the necessary backup files to the mounted volume. Make sure this volume will be available to your new v7 deployment to restore the data from it. Consider using an absolute path instead of "./backup-all".
2. Set up a fresh v7 deployment by following the standard [deployment instructions](https://github.com/hcengineering/huly-selfhost/blob/main/README.md).
3. Restore the data from the backup created in step 1. Make sure the deployment is new and doesn't contain any data as it might result in conflicts during the restore procedure. Run the following command on the main branch of the `huly-selfhost` repository adjusting variables to the actual values of your deployment in case they differ from the ones in the sample deployment. Make sure that the mounted volume is referencing the same path as was used in the backup command.
```
source .env && docker run \
--network "${DOCKER_NAME}_huly_net" \
-e SERVER_SECRET="$SECRET" \
-e TRANSACTOR_URL="ws://transactor:3333" \
-e STORAGE_CONFIG="minio|minio?accessKey=minioadmin&secretKey=minioadmin" \
-e ACCOUNT_DB_URL="${CR_DB_URL}" \
-e ACCOUNTS_URL="http://account:3000" \
-e DB_URL="${CR_DB_URL}" \
-e QUEUE_CONFIG="redpanda:9092" \
-v ./backup-all:/backup \
-it hardcoreeng/tool:s0.7.251 \
-- bundle.js restore-from-v6-all /backup
```
> [!TIP]
> This procedure doesn't affect the data in the v6 deployment and can be repeated as many times as needed.
## v0.6
### v0.6.502
<details>
<summary>No changes required.</summary>
- v0.6.501
- v0.6.499
- v0.6.496
- v0.6.482
</details>
### v0.6.471
#### Overview
The new Mail Service, supporting both SMTP and Amazon SES, has been added. If your setup currently uses the `ses` service, you'll need to migrate to the `mail` service.
#### Key Changes
- **Unified Mail Service**: The `mail` service can be configured to send emails via SMTP or Amazon SES, but not both simultaneously.
- **Migration Requirement**: Transitioning from the `ses` service to the `mail` service requires updating your `docker-compose.yaml` file.
#### Migration Steps
1. **Update Configuration**: Replace the `ses` service with the `mail` service in your `docker-compose.yaml` file. Configure the environment variables to match your chosen email service (SMTP or SES).
2. **Rename Environment Variables**: If you're using SES, update your environment variables:
- Change `ACCESS_KEY` to `SES_ACCESS_KEY`
- Change `SECRET_KEY` to `SES_SECRET_KEY`
- Change `REGION` to `SES_REGION`
3. **Integrate the Mail Service**: Use `MAIL_URL` instead of `SES_URL` in `transactor` and `account` containers:
```yaml
account:
...
environment:
- MAIL_URL=http://mail:8097
...
transactor:
...
environment:
- MAIL_URL=http://mail:8097
...
```
4. **Web Push Notifications**: Add `WEB_PUSH_URL` to `transactor` container if you want to use web push notifications:
```yaml
transactor:
...
environment:
- MAIL_URL=http://mail:8097
- WEB_PUSH_URL=http://ses:3335
...
```
### v0.6.466
No changes required.
### v0.6.429
No changes required.
### v0.6.424
Web-push keys have been moved from the `front` service to the `ses` service. If you are using the `ses` service, you will need to update the configuration:
```yaml
front:
...
environment:
...
# Remove the following lines
# - PUSH_PUBLIC_KEY=your public key
# - PUSH_PRIVATE_KEY=your private key
ses:
...
environment:
...
# Add the following lines
- PUSH_PUBLIC_KEY=your public key
- PUSH_PRIVATE_KEY=your private key
```
### v0.6.411
No changes required.
### v0.6.405
No changes required.
### v0.6.377
#### Fulltext Service
Fulltext search functionality has been extracted into a separate `fulltext` service. This service is now required to be running in order to use the fulltext search functionality.
Configuration:
```yaml
fulltext:
image: hardcoreeng/fulltext:${HULY_VERSION}
ports:
- 4700:4700
environment:
- SERVER_SECRET=${HULY_SECRET}
- DB_URL=mongodb://mongodb:27017
- FULLTEXT_DB_URL=http://elastic:9200
- ELASTIC_INDEX_NAME=huly_storage_index
- STORAGE_CONFIG=minio|minio?accessKey=minioadmin&secretKey=minioadmin
- REKONI_URL=http://rekoni:4004
- ACCOUNTS_URL=http://account:3000
- STATS_URL=http://stats:4900
restart: unless-stopped
```
Update the `transactor` service to use the new `fulltext` service:
```yaml
transactor:
...
environment:
...
- FULLTEXT_URL=http://fulltext:4700
# Remove the following lines
# - ELASTIC_URL=http://elastic:9200
# - ELASTIC_INDEX_NAME=huly_storage_index
# - REKONI_URL=http://rekoni:4004
```
#### Statistics Service
New statistics service has been added. The serivce is responsible for collecting and storing statistics about the usage of the application.
Configuration:
```yaml
stats:
image: hardcoreeng/stats:${HULY_VERSION}
ports:
- 4900:4900
environment:
- PORT=4900
- SERVER_SECRET=${HULY_SECRET}
restart: unless-stopped
```
Other Huly services have been updated to use the new statistics service:
```yaml
...
environment:
- STATS_URL=http://stats:4900
...
```
Reference in New Issue View Git Blame Copy Permalink