Configuring

Configure your Feedbacky instance to your needs.

Open your .env file and edit the environment variables to fit your needs.

sudo nano .env

Networking

REACT_APP_SERVER_IP_ADDRESS

The IP address of your Virtual Private Server (VPS) or dedicated hardware or a domain.

CLIENT_APP_PORT

Port for the client application, by default it is 8090.

SERVER_APP_PORT

Port for the server application, by default it is 8095.

Domain

You can use your own domain with Feedbacky, follow the guide below.

Domain Setupchevron-right

Security

JWT_SECRET

A random generated token used for authentication purposes.

Use this link to generate one yourself;

Any other JWT secret token generation can also be used.
circle-exclamation

Database

MYSQL_USERNAME

The username set during the database setup process.

MYSQL_PASSWORD

The password set during the database setup process.

MYSQL_URL

Connection information that will be used by Feedbacky.

OAuth

Follow these steps to use the Discord OAuth.

1. Access Discord's Developer Portalarrow-up-right.

2. Create a new OAuth application.

3. Add a new redirect with the IP address or domain set here and include /auth/discord at the end.

Follow these steps to use the GitHub OAuth.

1. Access GitHub's Developer settingsarrow-up-right.

2. Create a new OAuth application.

3. Fill the Authorization callback URL with the IP address or domain set here and include /auth/github at the end.
triangle-exclamation

Follow these steps to use the GitLab OAuth.

1. Access GitLab's Developer Portalarrow-up-right.

2. Create a new OAuth application.

3. Add a new redirect with the IP address or domain set here and include /auth/gitlab at the end.

4. Fill the necessary variables with your newly created Discord OAuth application.

OAUTH_GITLAB_ENABLED

Disabled by default, to use GitLab OAuth change to true.

OAUTH_GITLAB_REDIRECT_URI

Your instance domain with /auth/gitlab included at the end.

OAUTH_GITLAB_CLIENT_ID

Your OAuth client ID.

OAUTH_GITLAB_SECRET

Your OAuth client secret.

Mail

MAIL_SERVICE_TYPE

Choose one of the options below.

MAIL_SMTP_USERNAME

Your username.

MAIL_SMTP_PASSWORD

The password.

MAIL_SMTP_HOST

A reachable domain or IP address.

MAIL_SMTP_PORT

A reachable port, by default it is 25.

Image Compression

IMAGE_COMPRESSION_ENABLED

If you wish to use an Image compression service, false by default.

IMAGE_COMPRESSION_TYPE

At the moment Feedbacky only supports one image compression service.

CheetahOarrow-up-right is an image compression service supported by Feedbacky.

circle-info

Compress up to 500 images for free each months.

Pricing included for your convenience and may be out of date.

IMAGE_COMPRESSION_CHEETAHO_API_KEY

Your CheetahO API key.

Integrations

circle-info

Integrations are only available for cloud-instance users at the moment!

Last updated