Skip to content

Commit

Permalink
fix: Add details about initial administrator account
Browse files Browse the repository at this point in the history
  • Loading branch information
meltyshev committed Oct 20, 2023
1 parent f5689ab commit a9091b2
Show file tree
Hide file tree
Showing 14 changed files with 59 additions and 19 deletions.
1 change: 0 additions & 1 deletion docs/API/PHP.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,3 @@ All necessary entrypoints are conveniently divided into controllers. You can vie
in the `src/Controllers/` folder.

Result data output is strongly typed and returned in Dto objects

2 changes: 1 addition & 1 deletion docs/Configuration/Import from Trello.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
### Import from Trello

It's already available in Planka, or you can also use the great tool [trello2planka](https://github.com/christophenne/trello2planka) to do the import.
It's already available in Planka, or you can also use the great tool [trello2planka](https://github.com/christophenne/trello2planka) to do the import.
2 changes: 1 addition & 1 deletion docs/Configuration/Planka as service.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ sudo env PATH=$PATH:/usr/bin /usr/lib/node_modules/pm2/bin/pm2 startup systemd -

```bash
pm2 save
```
```
2 changes: 1 addition & 1 deletion docs/Configuration/backups/BareMetal.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
####

Comming soon
Comming soon
2 changes: 1 addition & 1 deletion docs/Configuration/backups/Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Importing project-background-images ... Success!
Importing attachments ... Success!
Cleaning up temporary files and folders ... Success!
Restore complete!
```
```
2 changes: 1 addition & 1 deletion docs/Configuration/webserver/Apache2.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Here is an example of Apache2 configuration for Planka, make sure to replace dom
ProxyPassReverse / http://localhost:1337/

</VirtualHost>
```
```
2 changes: 1 addition & 1 deletion docs/Configuration/webserver/NGINX.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ server {
proxy_pass http://planka;
}
}
``
``
7 changes: 4 additions & 3 deletions docs/Development.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ Either use a local database or start the provided development database:
docker-compose -f docker-compose-dev.yml up
```

Create `server/.env` based on `server/.env.sample` and edit `DATABASE_URL` if needed, then initialize the database:
Create `server/.env` based on `server/.env.sample` and edit `DATABASE_URL` if needed.\
Uncomment and edit `DEFAULT_ADMIN_*` variables if you need an initial administrator account.

Then initialize the database:

```
npm run server:db:init
Expand All @@ -28,5 +31,3 @@ Start the development server:
```
npm start
```

Demo user: [email protected] demo
2 changes: 1 addition & 1 deletion docs/installl-planka/Automated installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
sidebar_position: 4
---
---
24 changes: 22 additions & 2 deletions docs/installl-planka/Debian & Ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ Your ``.env`` file should look like this

```bash
## Required
BASE_URL=YOUR_DOMAINNAME
BASE_URL=http://YOUR_DOMAIN_NAME:YOUR_PORT
DATABASE_URL=postgresql://planka:YOUR_DATABASE_PASSWORD@localhost/planka
SECRET_KEY=YOUR_GENERATED_KEY

Expand All @@ -206,6 +206,26 @@ SECRET_KEY=YOUR_GENERATED_KEY
# TRUST_PROXY=0
# TOKEN_EXPIRES_IN=365 # In days

# related: https://github.com/knex/knex/issues/2354
# As knex does not pass query parameters from the connection string we
# have to use environment variables in order to pass the desired values, e.g.
# PGSSLMODE=<value>

# Configure knex to accept SSL certificates
# KNEX_REJECT_UNAUTHORIZED_SSL_CERTIFICATE=false

DEFAULT_ADMIN_EMAIL=YOUR_ADMIN_EMAIL # Do not remove if you want to prevent this user from being edited/deleted
DEFAULT_ADMIN_PASSWORD=YOUR_ADMIN_PASSWORD
DEFAULT_ADMIN_NAME=YOUR_ADMIN_NAME
DEFAULT_ADMIN_USERNAME=YOUR_ADMIN_USERNAME

# OIDC_ISSUER=
# OIDC_CLIENT_ID=
# OIDC_CLIENT_SECRET=
# OIDC_SCOPES=openid email profile
# OIDC_ADMIN_ROLES=admin
# OIDC_ROLES_ATTRIBUTE=groups

## Do not edit this

TZ=UTC
Expand All @@ -220,4 +240,4 @@ in the ``/var/www/planka/server`` directory just type
npm run db:init && npm start --prod
```

Now you can browse to **http://YOUR_DOMAINNAME:1337** and login with ``[email protected]`` with password ``demo``
Now you can browse to **http://YOUR_DOMAIN_NAME:YOUR_PORT** and login as **YOUR_ADMIN_EMAIL** with password **YOUR_ADMIN_PASSWORD**
3 changes: 2 additions & 1 deletion docs/installl-planka/Docker Compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ sidebar_position: 1
- Create `docker-compose.yml` based on [the example](https://raw.githubusercontent.com/plankanban/planka/master/docker-compose.yml). This is the ONLY file you will need. You can create this file on your own machine by copy and pasting the content.
- Edit `BASE_URL` to match your domain name or IP address.
- Edit `SECRET_KEY` with random value. You can generate it by `openssl rand -hex 64`.
- Uncomment and edit `DEFAULT_ADMIN_*` variables if you need an initial administrator account.

Download the docker-compose.yml:

Expand All @@ -23,4 +24,4 @@ Pull images and start services:
docker-compose up -d
```

Now you can browse to **http://YOUR_DOMAINNAME:YOUR_PORT** and login with ``[email protected]`` with password ``demo``
Now you can browse to **http://YOUR_DOMAIN_NAME:YOUR_PORT** and login as **YOUR_ADMIN_EMAIL** with password **YOUR_ADMIN_PASSWORD**
1 change: 0 additions & 1 deletion docs/installl-planka/Getting started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
sidebar_position: 0
---

4 changes: 2 additions & 2 deletions docs/installl-planka/Helm Chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ helm install planka . -f planka.yaml
```

### Access Planka
Now you can browse to **http://YOUR_DOMAINNAME:YOUR_PORT** and login with ``[email protected]`` with password ``demo``
Now you can browse to **http://YOUR_DOMAIN_NAME:YOUR_PORT** and login as **YOUR_ADMIN_EMAIL** with password **YOUR_ADMIN_PASSWORD**



Expand All @@ -96,4 +96,4 @@ By using the Bitnami chart for PostgreSQL, there is an issue where once deployed

> **Warning!** Setting a password will be ignored on new installation in the case when previous Posgresql release was deleted through the helm command. In that case, old PVC will have an old password, and setting it through helm won't take effect. Deleting persistent volumes (PVs) will solve the issue. Refer to [issue 2061](https://github.com/bitnami/charts/issues/2061) for more details
If you want to fully uninstall this chart including the data, follow [these steps](https://github.com/bitnami/charts/blob/main/bitnami/postgresql/README.md#uninstalling-the-chart) from the Bitnami Chart's docs.
If you want to fully uninstall this chart including the data, follow [these steps](https://github.com/bitnami/charts/blob/main/bitnami/postgresql/README.md#uninstalling-the-chart) from the Bitnami Chart's docs.
24 changes: 22 additions & 2 deletions docs/installl-planka/Windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Your ``.env`` file should look like this

```batch
## Required
BASE_URL=YOUR_DOMAINNAME:YOUR_PORT
BASE_URL=http://YOUR_DOMAIN_NAME:YOUR_PORT
DATABASE_URL=postgresql://planka:YOUR_DATABASE_PASSWORD@localhost/planka
SECRET_KEY=YOUR_GENERATED_KEY
Expand All @@ -83,6 +83,26 @@ SECRET_KEY=YOUR_GENERATED_KEY
# TRUST_PROXY=0
# TOKEN_EXPIRES_IN=365 # In days
# related: https://github.com/knex/knex/issues/2354
# As knex does not pass query parameters from the connection string we
# have to use environment variables in order to pass the desired values, e.g.
# PGSSLMODE=<value>
# Configure knex to accept SSL certificates
# KNEX_REJECT_UNAUTHORIZED_SSL_CERTIFICATE=false
DEFAULT_ADMIN_EMAIL=YOUR_ADMIN_EMAIL # Do not remove if you want to prevent this user from being edited/deleted
DEFAULT_ADMIN_PASSWORD=YOUR_ADMIN_PASSWORD
DEFAULT_ADMIN_NAME=YOUR_ADMIN_NAME
DEFAULT_ADMIN_USERNAME=YOUR_ADMIN_USERNAME
# OIDC_ISSUER=
# OIDC_CLIENT_ID=
# OIDC_CLIENT_SECRET=
# OIDC_SCOPES=openid email profile
# OIDC_ADMIN_ROLES=admin
# OIDC_ROLES_ATTRIBUTE=groups
## Do not edit this
TZ=UTC
Expand All @@ -98,7 +118,7 @@ npm run db:init
npm start --prod
```

Now you can browse to **http://YOUR_DOMAINNAME:1337** and login with ``[email protected]`` with password ``demo``
Now you can browse to **http://YOUR_DOMAIN_NAME:YOUR_PORT** and login as **YOUR_ADMIN_EMAIL** with password **YOUR_ADMIN_PASSWORD**


### Problems
Expand Down

0 comments on commit a9091b2

Please sign in to comment.