Skip to content

Commit 806453b

Browse files
committed
added info on release package install
1 parent 387517f commit 806453b

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

doc/server.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,39 @@ docker-compose exec meh /app/meh
5252

5353
Use the [command line tool](cli.md) to [initialize the database](migrate.md) and configure your installation. [Configuration](configuration.md) can also be done via environment variables.
5454

55-
## Manual Setup
55+
## Manual Setup (production)
5656

5757
Of course, you can run the whole thing the classical way.
5858

5959
### Requirements
6060

61+
- PHP 8.1 or higher
62+
- SQLite extension for PHP
63+
- Web server (Apache, Nginx, etc.)
64+
65+
### Installation Steps
66+
67+
1. Download the latest meh-release.zip from https://github.com/splitbrain/meh/releases
68+
69+
2. Unzip the archive on your server
70+
```bash
71+
unzip meh-release.zip
72+
```
73+
3. Point the document root of your web server to the `public` directory
74+
75+
Use the [command line tool](cli.md) to [initialize the database](migrate.md) and configure your installation. [Configuration](configuration.md) can also be done via environment variables.
76+
77+
### URL Rewriting
78+
79+
Meh requires URL rewriting to work correctly. There's a `.htaccess` file included that handles this for Apache. For other web servers, you need to configure URL rewriting manually.
80+
81+
82+
## Manual Setup (development)
83+
84+
If you want to tinker with the code, you will need to use composer and node to install and build the dependencies.
85+
86+
### Requirements
87+
6188
- PHP 8.1 or higher
6289
- SQLite extension for PHP
6390
- Composer (for installation)
@@ -75,7 +102,7 @@ Of course, you can run the whole thing the classical way.
75102
2. Install backend dependencies:
76103
```bash
77104
cd backend
78-
composer install --no-dev
105+
composer install
79106
cd ..
80107
```
81108

@@ -87,11 +114,9 @@ Of course, you can run the whole thing the classical way.
87114
cd ..
88115
```
89116

90-
4. Point your web server to the `public` directory
117+
4. Use the PHP development server your web server to the `public` directory
118+
```bash
119+
php -S localhost:8000 -t public
120+
```
91121

92122
Use the [command line tool](cli.md) to [initialize the database](migrate.md) and configure your installation. [Configuration](configuration.md) can also be done via environment variables.
93-
94-
95-
### URL Rewriting
96-
97-
Meh requires URL rewriting to work correctly. There's a `.htaccess` file included that handles this for Apache. For other web servers, you need to configure URL rewriting manually.

0 commit comments

Comments
 (0)