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

Update README.md

Browse source 
Fix the url for paths
This commit is contained in:
Awiteb 2024-03-04 01:15:08 +03:00
parent a4ec552b3e
commit a217b6d328
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -11,13 +11,13 @@ Others are only contributors means that they can only fork your repository and m
they can't create repositories.
## Imortant notes
After you create your account, you need to change your account visibility to public, by going to your profile and then click on the settings and then change the visibility to public, then change the [app.ini](/forgejo/forgejo/conf/app.ini) and remove the `public` visibility from the `ALLOWED_USER_VISIBILITY_MODES`. This will make you the only visible user in the instance.
After you create your account, you need to change your account visibility to public, by going to your profile and then click on the settings and then change the visibility to public, then change the [app.ini](./forgejo/forgejo/conf/app.ini) and remove the `public` visibility from the `ALLOWED_USER_VISIBILITY_MODES`. This will make you the only visible user in the instance.
## Secrets
Forgejo will add the secrets to the [app.ini](/forgejo/forgejo/conf/app.ini) file, so make sure to not remove the [app.ini](/forgejo/forgejo/conf/app.ini) file from the repository, and do not share it with anyone.
Forgejo will add the secrets to the [app.ini](./forgejo/forgejo/conf/app.ini) file, so make sure to not remove the [app.ini](./forgejo/forgejo/conf/app.ini) file from the repository, and do not share it with anyone.
## How to use this configuration?
Just clone this repository, then read the [app.ini](/forgejo/forgejo/conf/app.ini) file and changes the values to your needs, then run the following command:
Just clone this repository, then read the [app.ini](./forgejo/forgejo/conf/app.ini) file and changes the values to your needs, then run the following command:
```bash
sed -i -e "s/{SHARED_SECRET}/$(openssl rand -hex 20)/" docker-compose.yml
docker-compose up -d
@ -25,7 +25,7 @@ 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
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
by running `docker-compose rm -s -f` and then run `docker-compose up -d` again.
## Restaring
@ -35,11 +35,11 @@ When you want to restart the forgejo, do not run `docker-compose restart` I see
Is using sqlite3, and is more than enough for personal use.
## Backup
The data is stored in the [forgejo](/forgejo) directory and [forgejo-runner](/forgejo-runner) directory, so you can backup them.
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.
## How to contribute?
Make issue first to discuss the changes, then make pull request (if the issue is accepted)
## License
The configuration is licensed under the MIT License. See [LICENSE](/LICENSE) file for more information.
The configuration is licensed under the MIT License. See [LICENSE](./LICENSE) file for more information.