diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 19535d27f..d12da9052 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -54,5 +54,11 @@ export default defineConfig({ { icon: 'github', link: 'https://git.homebox.software' }, { icon: 'mastodon', link: 'https://noc.social/@sysadminszone' }, ] + }, + + markdown: { + image: { + lazyLoading: true + } } }) diff --git a/docs/.vitepress/menus/en.mts b/docs/.vitepress/menus/en.mts index 9063d7730..74ad85e20 100644 --- a/docs/.vitepress/menus/en.mts +++ b/docs/.vitepress/menus/en.mts @@ -4,8 +4,9 @@ export default [ items: [ {text: 'Quick Start', link: '/en/quick-start'}, {text: 'Installation', link: '/en/installation'}, - {text: 'Organizing Your Items', link: '/en/organizing-items'}, {text: 'Configure Homebox', link: '/en/configure-homebox'}, + {text: 'Upgrade', link: '/en/upgrade'}, + {text: 'Organizing Your Items', link: '/en/organizing-items'}, {text: 'Tips and Tricks', link: '/en/tips-tricks'} ] }, diff --git a/docs/en/upgrade.md b/docs/en/upgrade.md new file mode 100644 index 000000000..2b7f34d3e --- /dev/null +++ b/docs/en/upgrade.md @@ -0,0 +1,13 @@ +# Upgrade + +## From v0.x.x to v1.0.0 + +::: danger Breaking Changes +This upgrade process involves some potentially breaking changes, please review this documentation carefully before beginning the upgrade process, and follow it closely during your upgrade. +::: + +### Configuration Changes +#### Database Configuration +- `HBOX_STORAGE_SQLITE_URL` has been replaced by `HBOX_DATABASE_SQLITE_PATH` +- `HBOX_DATABASE_DRIVER` has been added to set the database type, valid options are `sqlite3` and `postgres` +- `HBOX_DATABASE_HOST`, `HBOX_DATABASE_PORT`, `HBOX_DATABASE_USERNAME`, `HBOX_DATABASE_DATABASE`, and `HBOX_DATABASE_SSL_MODE` have been added to configure postgres connection options. \ No newline at end of file