cleanup README and add removal instruction
This commit is contained in:
parent
bb1c3bbb3e
commit
3d820f95ce
17
README.md
17
README.md
|
@ -1,8 +1,7 @@
|
||||||
# Debian Packages for Forgejo
|
# Debian Packages for Forgejo
|
||||||
Hello! If you're want to run Forgejo on Debian/Ubuntu and you're looking for packages to install it to your system, you've come to the right place!
|
Hello! If you want to run Forgejo on Debian/Ubuntu and you're looking for packages to install it to your system, you've come to the right place!
|
||||||
|
|
||||||
#### Build tests
|
### Build test: [![ci-status](https://ci.cryxtal.org/api/badges/crystal/forgejo-deb/status.svg)](https://ci.cryxtal.org/crystal/forgejo-deb)
|
||||||
[![ci-status](https://ci.cryxtal.org/api/badges/crystal/forgejo-deb/status.svg)](https://ci.cryxtal.org/crystal/forgejo-deb)
|
|
||||||
|
|
||||||
## Download info
|
## Download info
|
||||||
You can find the latest release downloads in [the releases tab](https://codeberg.org/crystal/forgejo-deb/releases). There are currently 3 packages built by this script.
|
You can find the latest release downloads in [the releases tab](https://codeberg.org/crystal/forgejo-deb/releases). There are currently 3 packages built by this script.
|
||||||
|
@ -11,6 +10,16 @@ You can find the latest release downloads in [the releases tab](https://codeberg
|
||||||
- `forgejo-bin`: A Debian package with the official Forgejo binary, in case you don't trust my builds
|
- `forgejo-bin`: A Debian package with the official Forgejo binary, in case you don't trust my builds
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
These packages are easy to use! Just download your preferred package, install it with `apt install ./forgejo-*-linux-amd64.deb` and point your browser to `http://localhost:3000`. The package will set up Forgejo as a systemd service and take care of creating a new user for Forgejo, so all you need to do is set it up to your liking.
|
These packages are easy to use! Just download your preferred package, install it with `sudo apt install ./forgejo*_amd64.deb` and point your browser to `http://localhost:3000`. The package will set up Forgejo as a systemd service and take care of creating a new user for Forgejo, so all you need to do is set it up to your liking.
|
||||||
|
|
||||||
The default username for Forgejo's user is `forgejo`, but it can easily be changed prior to installation, for example if you would rather run Forgejo as user `git`. All you need to do is download the files from the `etc` folder in this repository, put them in the respective places on your system, and customize them to your liking. When you use apt to install the Forgejo package, it will create a new user with the specified settings.
|
The default username for Forgejo's user is `forgejo`, but it can easily be changed prior to installation, for example if you would rather run Forgejo as user `git`. All you need to do is download the files from the `etc` folder in this repository, put them in the respective places on your system, and customize them to your liking. When you use apt to install the Forgejo package, it will create a new user with the specified settings.
|
||||||
|
|
||||||
|
## Removal
|
||||||
|
Removing Forgejo itself from your system is simple, just `sudo apt remove forgejo(-sqlite|-bin)`. If you use `sudo apt purge`, the related configuration files will also be removed from `/etc/forgejo`. To avoid accidentally destroying user data, other things including the Forgejo user will be left behind. The following commands will remove everything from your system.
|
||||||
|
```sh
|
||||||
|
sudo apt purge forgejo
|
||||||
|
sudo rm -rf /var/lib/forgejo
|
||||||
|
sudo rm -rf /etc/forgejo /etc/default/forgejo /etc/systemd/system/forgejo.service.d
|
||||||
|
sudo deluser forgejo
|
||||||
|
```
|
||||||
|
If you customized the user or home directory before installing Forgejo, make sure to adjust the commands accordingly. If you get an error saying the files you are trying to delete do not exist, don't worry about it.
|
||||||
|
|
Loading…
Reference in a new issue