Skip to content

Commit 36527cc

Browse files
authored
docs(readme): add After install section + expand wiki links + tighten manual install steps
1 parent 24ba01c commit 36527cc

1 file changed

Lines changed: 21 additions & 64 deletions

File tree

README.md

Lines changed: 21 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Built for homelabs, teams, and client portals that need fast browsing, strict AC
2121
- [Quick links](#quick-links)
2222
- [Install (Docker – recommended)](#install-docker--recommended)
2323
- [Manual install (PHP web server)](#manual-install-php-web-server)
24+
- [After install (5 minutes)](#after-install-5-minutes)
2425
- [Data & backups](#data--backups)
2526
- [First-run security checklist](#first-run-security-checklist)
2627
- [Optional dependencies](#optional-dependencies)
@@ -91,16 +92,20 @@ Full list of features: [Full Feature Wiki](https://github.com/error311/FileRise/
9192
- 🧩 **FileRise Pro:** [filerise.net](https://filerise.net)
9293
- 📚 **Docs & Wiki:** [Wiki](https://github.com/error311/FileRise/wiki)
9394
- [Features overview](https://github.com/error311/FileRise/wiki/Features)
95+
- [FAQ](https://github.com/error311/FileRise/wiki/FAQ)
96+
- [Screenshots](https://github.com/error311/FileRise/wiki/Screenshots)
9497
- [Installation & setup](https://github.com/error311/FileRise/wiki/Installation-Setup)
9598
- [Common env vars](https://github.com/error311/FileRise/wiki/Common-Env-Variables)
9699
- [Env vars (full reference)](https://github.com/error311/FileRise/wiki/Environment-Variables-Full-Reference)
100+
- [ACL & permissions](https://github.com/error311/FileRise/wiki/ACL-and-Permissions)
97101
- [WebDAV (mount)](https://github.com/error311/FileRise/wiki/WebDAV)
98102
- [WebDAV via curl](https://github.com/error311/FileRise/wiki/Accessing-FileRise-via-curl%C2%A0(WebDAV))
99103
- [ONLYOFFICE](https://github.com/error311/FileRise/wiki/ONLYOFFICE)
100104
- [OIDC & SSO](https://github.com/error311/FileRise/wiki/OIDC-and-SSO)
101105
- [Nginx setup](https://github.com/error311/FileRise/wiki/Nginx-Setup)
102106
- [Kubernetes / k8s](https://github.com/error311/FileRise/wiki/Kubernetes---k8s-deployment)
103107
- [Backup & restore](https://github.com/error311/FileRise/wiki/Backup-and-Restore)
108+
- [Upgrade & migration](https://github.com/error311/FileRise/wiki/Upgrade-and-Migration)
104109
- [Reverse proxy & subpath](https://github.com/error311/FileRise/wiki/Reverse-Proxy-and-Subpath)
105110
- 🐳 **Docker image:**
106111
- Docker Hub: [Docker](https://hub.docker.com/r/error311/filerise-docker)
@@ -227,29 +232,10 @@ docker compose up -d
227232

228233
## Manual install (PHP web server)
229234

230-
> ⚠️ **Manual installs: understand the default paths (saves you 30 minutes of pain)**
231-
>
232-
> By default, FileRise writes data to **these absolute paths**:
233-
>
234-
> - `/var/www/uploads`
235-
> - `/var/www/users`
236-
> - `/var/www/metadata`
237-
>
238-
> Your web server must point to FileRise’s **public/** folder:
239-
>
240-
> - DocumentRoot → `/var/www/filerise/public` (example)
241-
>
242-
> **Recommended layout (no config changes):**
243-
>
244-
> - Install FileRise code in: `/var/www/filerise`
245-
> - Create data dirs in: `/var/www/uploads`, `/var/www/users`, `/var/www/metadata`
246-
>
247-
> If you install FileRise under `/var/www/html` (or anywhere else), you must either:
248-
>
249-
> - still create the data folders at `/var/www/{uploads,users,metadata}` **(simplest)**, or
250-
> - change the paths in `config/config.php` to match your layout.
251-
>
252-
>If you created `users/metadata/uploads` under `/var/www/html`, FileRise will still try to write to `/var/www/users` unless you change config.
235+
Short version: FileRise expects data at `/var/www/{uploads,users,metadata}` and your web server must point to the **public/** folder (for example `DocumentRoot /var/www/filerise/public`).
236+
237+
Full guide + troubleshooting:
238+
[Installation & setup](https://github.com/error311/FileRise/wiki/Installation-Setup)[Upgrade & migration](https://github.com/error311/FileRise/wiki/Upgrade-and-Migration)[Reverse proxy & subpath](https://github.com/error311/FileRise/wiki/Reverse-Proxy-and-Subpath)
253239

254240
### Requirements
255241

@@ -258,29 +244,17 @@ docker compose up -d
258244
- PHP extensions: `json`, `curl`, `zip` (and usual defaults)
259245
- No database required
260246

261-
### Step 0: Create data directories (default locations)
247+
### Quick start (release ZIP)
248+
249+
1) Create data directories:
262250

263251
```bash
264252
sudo mkdir -p /var/www/uploads /var/www/users /var/www/metadata
265253
sudo chown -R www-data:www-data /var/www/uploads /var/www/users /var/www/metadata # adjust web user if needed
266254
sudo chmod -R 775 /var/www/uploads /var/www/users /var/www/metadata
267255
```
268256

269-
Quick write test:
270-
271-
```bash
272-
sudo -u www-data touch /var/www/users/.write_test && echo OK
273-
```
274-
275-
### Login security notes
276-
277-
- Failed login attempts are throttled per **IP + username** and stored in `/var/www/users/failed_logins.json` by default.
278-
- Failed logins are also written to `/var/www/users/fail2ban.log` (rotate at 50MB, keep 5 files).
279-
- If you’re behind a reverse proxy, set `FR_TRUSTED_PROXIES` and `FR_IP_HEADER` so rate limiting and logs use the real client IP.
280-
281-
### Install from release ZIP (recommended)
282-
283-
Get the latest tag from [Releases](https://github.com/error311/FileRise/releases).
257+
2) Download a release and extract:
284258

285259
```bash
286260
cd /var/www
@@ -295,35 +269,18 @@ curl -fsSL "https://github.com/error311/FileRise/releases/download/${VERSION}/${
295269
unzip "${ASSET}"
296270
```
297271

298-
Point your web server at `public/`:
272+
3) Point your web server at `/var/www/filerise/public`, then visit `http://serverip/`.
299273

300-
- Apache: `DocumentRoot /var/www/filerise/public`
301-
- Nginx: `root /var/www/filerise/public;`
274+
If you install FileRise outside `/var/www/filerise`, keep the data dirs in `/var/www` or update the paths in `config/config.php`.
302275

303-
> ✅ After setting DocumentRoot to `.../public`, access FileRise at:
304-
> `http://serverip/` (not `http://serverip/public/`)
305-
306-
### Install from git (developer mode)
307-
308-
```bash
309-
cd /var/www
310-
sudo git clone https://github.com/error311/FileRise.git filerise
311-
sudo chown -R $USER:$USER /var/www/filerise
312-
313-
cd /var/www/filerise
314-
composer install
315-
```
276+
---
316277

317-
### Manual install troubleshooting (common mistakes)
278+
## After install (5 minutes)
318279

319-
- **Browsing `/public` in the URL**
320-
- Wrong: `http://serverip/public/`
321-
- Correct: `http://serverip/`
322-
- **“Failed to write users file”**
323-
- Check your server error log — it will show the exact write path.
324-
- If it mentions `/var/www/users/users.txt`, fix permissions on `/var/www/users` (not `/var/www/html/users`).
325-
- **open_basedir restrictions**
326-
- Ensure it includes `/var/www` and `/tmp` (example: `/var/www:/tmp`).
280+
- Log in and create your first admin account (prompted on first run).
281+
- Open Admin → Users to add accounts, then Admin → Folder Access to set permissions.
282+
- If you’re behind a reverse proxy or subpath, set `FR_PUBLISHED_URL` (and `FR_BASE_PATH` if needed).
283+
- Optional: enable WebDAV or ONLYOFFICE in Admin and follow the wiki guides.
327284

328285
---
329286

0 commit comments

Comments
 (0)