Skip to content

Commit 97b1327

Browse files
authored
Merge pull request #24 from homerr/docupdates
fixing typos and mistakes in readme-vars
2 parents 230df31 + 5b16b0f commit 97b1327

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

readme-vars.yml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ param_env_vars:
2929
- { env_var: "DB_USER", env_value: "<yourdbuser>", desc: "for specifying the database user" }
3030
- { env_var: "DB_PASS", env_value: "<yourdbpass>", desc: "for specifying the database password" }
3131
- { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" }
32-
- { env_var: "APPURL", env_value: "your.site.here.xyz", desc: "for specifying the url your application will be accessed on "}
32+
- { env_var: "APP_URL", env_value: "your.site.here.xyz", desc: "for specifying the url your application will be accessed on (required for correct operation of reverse proxy)"}
3333

3434
param_usage_include_ports: true
3535
param_ports:
@@ -45,10 +45,11 @@ app_setup_block: |
4545
**Note** this will allow any user with these credentials to connect to the server, it is not limited to localhost
4646
4747
```
48-
from shell: mysql -u root -p
48+
from shell on sql container:
49+
mysql -u root -p
4950
CREATE DATABASE bookstackapp;
5051
GRANT USAGE ON *.* TO 'myuser'@'%' IDENTIFIED BY 'mypassword';
51-
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@%;
52+
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@'%';
5253
FLUSH PRIVILEGES;
5354
```
5455
@@ -58,14 +59,14 @@ app_setup_block: |
5859
5960
Default username is admin@admin.com with password of **password**
6061
61-
If you intend to use this application behind a reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APPURL` environment variable is set, or it will not work
62+
If you intend to use this application behind a reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APP_URL` environment variable is set, or it will not work
6263
63-
Documentation can be found at https://www.bookstackapp.com/docs/
64+
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
6465
65-
### Advanced Users
66+
### Advanced Users (full control over the .env file)
6667
If you wish to use the extra functionality of BookStack such as email, memcache, ldap and so on you will need to make your own .env file with guidance from the BookStack documentation.
6768
68-
When you create the container, do not set any arguements for SQL or APPURL. The container will copy an .env file to /config/www/.env on your host system for you to edit.
69+
When you create the container, do not set any arguments for any SQL settings, or APP_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit.
6970
7071
### Composer
7172

0 commit comments

Comments
 (0)