awiteb/forgejo-conf-files
1
Fork 0
Code Issues Pull requests Releases Activity Actions

Update README.md

Browse source
This commit is contained in:
Awiteb 2024-03-21 00:33:30 +03:00
parent 20f906035b
commit 8da08b9881
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
1 changed files with 28 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -25,12 +25,24 @@ docker-compose up -d
The instance will be available at `http://0.0.0.0:8080` so proxy it to your domain.
## Upgrading
When you want to upgrade the forgejo version, change the version in the [docker-compose.yml](./docker-compose.yml) file and then remove the containers
### Patch
Stop the instance using `docker-compose rm -s -f` then remove the forgejo image using `docker rmi -f <IMAGE ID>` then rerun the instace using `docker-compose up -d`
> TIP
>
> You can use `just update_patch`
### Major,Mirror
Change the version in the [docker-compose.yml](./docker-compose.yml) file and then remove the containers
by running `docker-compose rm -s -f` and then run `docker-compose up -d` again.
## Restaring
When you want to restart the forgejo, do not run `docker-compose restart` I see that makes some changes to the configuration, so it's better to remove the containers by running `docker-compose rm -s -f` and then run `docker-compose up -d` again.
> TIP
>
> You can use `just restart`
## Database
Is using sqlite3, and is more than enough for personal use.
@ -38,6 +50,21 @@ Is using sqlite3, and is more than enough for personal use.
The data is stored in the [forgejo](./forgejo) directory and [forgejo-runner](./forgejo-runner) directory, so you can backup them.
The containers are stateless, so it's do not store any data.
> TIP
>
> You can use `just backup <BACKUP NAME>`
## Justfile
Justfile will help you to work with the instance, you need to install [just](https://github.com/casey/just) CLI then this task will be available for you
| Name | Description | Example | Aliases |
|---|---|---|---|
| run | Run the instance | `just run` | r |
| stop | Stop the instance | `just stop` | s |
| update\_patch | Update to the latest patch version | `just update_patch` | u |
| restart | Restart the instance | `just restart` | N/A |
| backup | Backup the instance files | `just backup forgejo_backup` | b |
## How to contribute?
Make issue first to discuss the changes, then make pull request (if the issue is accepted)