From 77f04ff8d6229694b7c02f18bc4092b91d7b4a2d Mon Sep 17 00:00:00 2001 From: psychedelicious <4822129+psychedelicious@users.noreply.github.com> Date: Thu, 14 Dec 2023 08:25:32 +1100 Subject: [PATCH] docs: add warning to developer install about database & main --- docs/installation/020_INSTALL_MANUAL.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/installation/020_INSTALL_MANUAL.md b/docs/installation/020_INSTALL_MANUAL.md index 0ddf1bca68..b395405ba3 100644 --- a/docs/installation/020_INSTALL_MANUAL.md +++ b/docs/installation/020_INSTALL_MANUAL.md @@ -293,6 +293,19 @@ manager, please follow these steps: ## Developer Install +!!! warning + + InvokeAI uses a SQLite database. By running on `main`, you accept responsibility for your database. This + means making regular backups (especially before pulling) and/or fixing it yourself in the event that a + PR introduces a schema change. + + If you don't need persistent backend storage, you can use an ephemeral in-memory database by setting + `use_memory_db: true` under `Path:` in your `invokeai.yaml` file. + + If this is untenable, you should run the application via the official installer or a manual install of the + python package from pypi. These releases will not break your database. + + If you have an interest in how InvokeAI works, or you would like to add features or bugfixes, you are encouraged to install the source code for InvokeAI. For this to work, you will need to install the @@ -388,3 +401,5 @@ environment variable INVOKEAI_ROOT to point to the installation directory. Note that if you run into problems with the Conda installation, the InvokeAI staff will **not** be able to help you out. Caveat Emptor! + +[dev-chat]: https://discord.com/channels/1020123559063990373/1049495067846524939 \ No newline at end of file