Skip to content

made it more obvious, that users need to edit the env file #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericwang401 merged 2 commits into from
Dec 8, 2023
Merged

made it more obvious, that users need to edit the env file #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b58437
made it more obvious, that users need to edit the env file
staalexa Dec 8, 2023
5ce820d
Update .env file editing instructions
ericwang401 Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/guide/deployment/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,12 @@ First, we'll create a copy a new environment file.
cp .env.example .env
```

For the following section, you need to edit the ".env" file, you just created. To do so, open the file a text editor of your choice. For this guide, we'll use nano, which is bundled on many Linux-based systems.

```sh
nano .env
```

### Environment Configuration

First up, let's configure the display information and where this panel will be hosted. To determine what to use for `APP_URL`, first determine where you are hosting this panel. If you are hosting it on your IP address or locally, leave it as `http://localhost`. If you are hosting it on a domain, put `http://your-domain.name`. Additionally, if you want SSL automatically generated, replace `http://` with `https://` and make sure that your domain points to the IP address that's hosting Convoy. Please note that automatic SSL does not work with Cloudflare proxy.
Expand Down