Skip to content

Added Fedora install docs #1

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added Fedora install docs #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions docs/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,43 @@ You are advised to install PushBits behind a reverse proxy and enable TLS.
Currently, the only supported way of installing PushBits is via [Docker](https://www.docker.com/) or [Podman](https://podman.io/).
The image is hosted [via ghcr.io](https://github.com/pushbits/server/pkgs/container/server).

### UNSUPPORTED: Install on Fedora Linux
This method was tested on a Fedora Linux LXC Container running on Proxmox. They could probably work for other Linux distros.

1- Install sqlite.
```
sudo dnf install sqlite
```
2- Create a user.
```
sudo adduser pushbits
```
3- Move to the user directory

4- Download Pushbits and the Pushbits cli, and extract them in the user directory.

5- Copy the sample configuration, and edit it to fit your needs.

6- Start the server and test it.

7- Here is a simple Systemd unit for the new service. You can use it to start the server on boot, and to control it with Systemd.

```
[Unit]
Description=Pushbits notification server
After=network.target

[Service]
User=pushbits
Type=simple
WorkingDirectory=/home/pushbits
ExecStart=/home/pushbits/server
NoNewPrivileges=true

[Install]
WantedBy=multi-user.target
```

## Configuration

To see what can be configured, have a look at the [config.sample.yml](https://github.com/pushbits/server/blob/master/config.example.yml) file inside the root of the repository.
Expand Down