Commit 724eee63 authored by Pablo Rauzy's avatar Pablo Rauzy
Browse files

update README for multidomain + fix typos

parent de4fdf4c
......@@ -24,7 +24,7 @@ Adapt to use your own.
1. Configure your web server to point `example.com` to a directory (we'll call it `root`)
2. Next to the `root` directory (e.g., in the same parent directory), create a `users` and a `deleted` directory and give your web server write-permission to them.
Make sure neither the `users` not the `deleted` are web-facing (i.e., that they're not publicly accessible).
Make sure neither the `users` nor the `deleted` directories are web-facing (i.e., that they're not publicly accessible).
3. Configure your web server to point `*ANY*.example.com` to `users/*ANY*`.
......@@ -34,11 +34,12 @@ Make sure neither the `users` not the `deleted` are web-facing (i.e., that they'
* `register.php` is the registration form,
* `account.php` is the account management form (forgotten password, updating email),
* `manage.php` is the admin interface, it shows all account and allow to update their password, change their disk quota, and delete them.
* `manage.php` is the admin interface, it shows all accounts and allow to update their password, change their disk quota, or delete them.
.
6. Edit the `config.php` file to choose your admin credentials.
7. Also update `config.php` if necessary: “home” should be the path to our `users` directory, “delete” should be the path to our `deleted` directory, and “users” should be the path to the SQLite database we will create in the next installation step.
7. Also update `config.php` if necessary: “home” should be the path to the `users` directory, “delete” should be the path to the `deleted` directory, and “users” should be the path to the SQLite database we will create in the next installation step.
8. Create the users database (and then make sure the web server has write-permission for it). Here we assume the file is called `users.db`:
......@@ -51,3 +52,12 @@ Make sure neither the `users` not the `deleted` are web-facing (i.e., that they'
Another possibility is to register the “www” user normally using the `register.php` form and use it to edit the `example.com` landing page.
You can do that by creating a symlinks from `users/www` to `root`.
## Multi-domain mode
Cigala allows the use of multiple domain names if you set the “multidomain” entry to `true` in `config.php`.
The different domains have to be listed in the “domains” array in `config.php`.
The “home” and “deleted” entries can use the `%DOMAIN%` placeholder in the path, it will be replaced by the domain name without its TLD.
For example, if the “home” entry in `config.php` is `"../%DOMAIN%/users/"` and a user registers with `foobar.example.com`, its home will be in `../example/users/foobar/` (path relative to the `root` directory where the `cigala.php` file is).
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment