From 11043e9ba100c55dbea8e36239cf7c02e32f7170 Mon Sep 17 00:00:00 2001
From: Gautam Kumar <62495093+Gautam7352@users.noreply.github.com>
Date: Thu, 13 Mar 2025 21:39:15 +0530
Subject: [PATCH] doc: make default URL easier to notice
* Update README.md
Without clear instructions it wasted a few hours just for setting up.
Atleast no one will face issues with domain name in localhost now
* Making LocalHost website visible
* Making LocalHost website visible v2
---
README.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 78c11199..e91b64a8 100644
--- a/README.md
+++ b/README.md
@@ -47,8 +47,10 @@ cd puter
npm install
npm start
```
+✨ This should launch Puter at
+ http://puter.localhost:4100 (or the next available port).
+
-This will launch Puter at http://puter.localhost:4100 (or the next available port).
If this does not work, see [First Run Issues](./doc/self-hosters/first-run-issues.md) for
troubleshooting steps.
@@ -60,6 +62,8 @@ troubleshooting steps.
```bash
mkdir puter && cd puter && mkdir -p puter/config puter/data && sudo chown -R 1000:1000 puter && docker run --rm -p 4100:4100 -v `pwd`/puter/config:/etc/puter -v `pwd`/puter/data:/var/puter ghcr.io/heyputer/puter
```
+✨ This should launch Puter at
+ http://puter.localhost:4100 (or the next available port).
@@ -73,6 +77,8 @@ sudo chown -R 1000:1000 puter
wget https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml
docker compose up
```
+✨ This should be available at
+ http://puter.localhost:4100 (or the next available port).
@@ -86,6 +92,8 @@ New-Item -Path "puter\data" -ItemType Directory -Force
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml" -OutFile "docker-compose.yml"
docker compose up
```
+✨ This should launch Puter at
+ http://puter.localhost:4100 (or the next available port).