Skip to content

Commit

Permalink
Add upgrade guide documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tankerkiller125 authored Oct 30, 2024
1 parent f2475c8 commit d1febd5
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
})
3 changes: 2 additions & 1 deletion docs/.vitepress/menus/en.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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'}
]
},
Expand Down
13 changes: 13 additions & 0 deletions docs/en/upgrade.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit d1febd5

Please sign in to comment.