Skip to content

Update Docs for the new Update #51

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
merged 3 commits into from
Jan 28, 2025
Merged

Update Docs for the new Update #51

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5584640
Change Pre-Reqs File
egelhaus Jan 24, 2025
4d6932e
Fix Grammar Issues
egelhaus Jan 24, 2025
4888280
Fix ENV Format
egelhaus Jan 24, 2025
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
8 changes: 5 additions & 3 deletions components/snippets/installation-pre-reqs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ This section will ask you to install & configure several services exaplained bel

#### HTTPS is required (or localhost)

Postiz marks it's login cookies as Secure, which means you must run it either on localhost, or behind HTTPS - this is called a "secure context" in modern web browsers.
Postiz marks it's login cookies as Secure, this is called “secure context” in modern web browsers.

If you are not running either HTTPS or on localhost, then you will not be able to login, as your browser will refuse to send the login cookie.
If you want to use an secure Login Process, you need to set up an Certificate, which can be done via Reverse Proxy like Caddy or Nginx.

Postiz will not generate your HTTPS certificates for you, and it's servers cannot yet be configured to use a HTTPS certificate. This means you must use a reverse proxy to handle HTTPS. Documentation on popular reverse proxies can be found in the [reverse proxies](/reverse-proxies/) section, and if you've never used a reverse proxy with docker compose before, then [caddy](/reverse-proxies/caddy/) is recommended.
If you cannot use a certificate (HTTPS), add the following environment variable to your `.env` file:
`NOT_SECURED=true`
**Security Warning**: Setting `NOT_SECURED=true` disables secure cookie requirements. This should only be used in development environments or when you fully understand the security implications. Not recommended for production use.

#### Network Ports

Expand Down
Loading