Skip to content

Open source AI coding agent. Designed for large projects and real world tasks.

local/self_hosting quick start script

Dane Schneiderffcb82c1a098
diff --git a/README.md b/README.md
index a59290a7..79d9f044 100644
--- a/README.md
+++ b/README.md
@@ -232,7 +232,17 @@ Plandex Cloud accounts are free for now. In the future, they will cost somewhere
## Self-hosting  🏠
-[Read about self-hosting Plandex here.](./guides/HOSTING.md)
+Self-contained script for easy local mode and self-hosting:
+
+```bash
+git clone https://github.com/plandex-ai/plandex.git
+cd plandex/app
+./start_local.sh
+```
+
+Requires git, docker, and docker-compose.
+
+[Read more about self-hosting Plandex here.](./guides/HOSTING.md)
<br/>
diff --git a/app/start_local.sh b/app/start_local.sh
old mode 100644
new mode 100755
index 873f1246..64775ac4
--- a/app/start_local.sh
+++ b/app/start_local.sh
@@ -8,9 +8,6 @@ if ! [ -x "$(command -v git)" ]; then
exit 1
fi
-VERSION=$(cat ./server/version.txt) # or use the version you want
-git checkout server/v$VERSION
-
if ! [ -x "$(command -v docker)" ]; then
echo 'Error: docker is not installed.' >&2
echo 'Please install docker before running this setup script.' >&2
diff --git a/guides/HOSTING.md b/guides/HOSTING.md
index 67191296..ae439f72 100644
--- a/guides/HOSTING.md
+++ b/guides/HOSTING.md
@@ -1,5 +1,13 @@
# Plandex self-hosting 🏠
+## Quick start script ⚡️
+
+```bash
+git clone https://github.com/plandex-ai/plandex.git
+cd plandex/app
+./start_local.sh
+```
+
## Requirements
The Plandex server requires a PostgreSQL database (ideally v14), a persistent file system, git, and these environment variables (if using the docker build command below):
diff --git a/releases/server/versions/1.0.0.md b/releases/server/versions/1.0.0.md
index bc468638..4f139dcf 100644
--- a/releases/server/versions/1.0.0.md
+++ b/releases/server/versions/1.0.0.md
@@ -36,4 +36,14 @@
## 📚 🤔 Readme updates
-- The [readme](https://github.com/plandex-ai/plandex) has been revamped to be more informative, easier to navigate, and easier on the eyes. Check it out!
\ No newline at end of file
+- The [readme](https://github.com/plandex-ai/plandex) has been revamped to be more informative, easier to navigate, and easier on the eyes. Check it out!
+
+## 🏡 📦 Easy self-contained startup script for local mode and self-hosting
+
+```bash
+git clone https://github.com/plandex-ai/plandex.git
+cd plandex/app
+./start_local.sh
+```
+
+- Sincere thanks to @ZanzyTHEbar aka @daofficialwizard who wrote the script! 🙏
\ No newline at end of file