fixing readme
This commit is contained in:
parent
d3c6974743
commit
824bc635f2
21
README.md
21
README.md
@ -1,13 +1,12 @@
|
||||
# Gitea Incus Deployment Script
|
||||
|
||||
This script automates the deployment of Gitea using Incus containers. It provides a simple command-line interface to create a profile, install Gitea and PostgreSQL, and secure the configuration.
|
||||
This script automates the deployment of Gitea using a single Incus container with Docker Compose. It provides a simple command-line interface to create a profile and install Gitea with PostgreSQL.
|
||||
|
||||
## Table of Contents
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Usage](#usage)
|
||||
- [Create Profile](#create-profile)
|
||||
- [Install Gitea](#install-gitea)
|
||||
- [Secure Configuration](#secure-configuration)
|
||||
- [Script Behavior](#script-behavior)
|
||||
- [Notes](#notes)
|
||||
- [Customization](#customization)
|
||||
@ -42,7 +41,7 @@ If CPU or RAM is not specified, the default Incus values will be used.
|
||||
|
||||
### Install Gitea
|
||||
|
||||
Install Gitea and PostgreSQL:
|
||||
Install Gitea and PostgreSQL using Docker Compose:
|
||||
|
||||
```bash
|
||||
./gitea.sh install [-p dbpassword]
|
||||
@ -53,28 +52,22 @@ Options:
|
||||
|
||||
If no password is provided, a default password will be used.
|
||||
|
||||
### Secure Configuration
|
||||
|
||||
After completing the web installation, secure the Gitea configuration:
|
||||
|
||||
```bash
|
||||
./gitea.sh secure
|
||||
```
|
||||
|
||||
## Script Behavior
|
||||
|
||||
1. The script enforces the correct order of operations:
|
||||
- Profile must be created before installation
|
||||
- Gitea must be installed before securing the configuration
|
||||
2. The script will create a network named "incusbr0" if it doesn't exist
|
||||
3. The root disk size for the Incus container is set to 20GB by default
|
||||
4. Gitea will be accessible on port 3000, and SSH access will be on port 2222
|
||||
5. The script creates a single Incus container with nesting enabled
|
||||
6. Docker and Docker Compose are installed inside the Incus container
|
||||
7. Gitea and PostgreSQL are deployed using Docker Compose within the Incus container
|
||||
|
||||
## Notes
|
||||
|
||||
- After installation, access Gitea through the web interface to complete the setup
|
||||
- The script provides the URL to access Gitea after installation
|
||||
- Make sure to secure the configuration after completing the web setup
|
||||
- The latest versions of Gitea and PostgreSQL Docker images are used
|
||||
|
||||
## Customization
|
||||
|
||||
@ -93,5 +86,5 @@ You can modify the following variables at the top of the script to customize you
|
||||
|
||||
If you encounter any issues:
|
||||
1. Check the Incus container status: `incus list`
|
||||
2. View the container logs: `incus exec gitea -- journalctl -u gitea`
|
||||
2. View the container logs: `incus exec gitea -- docker-compose logs`
|
||||
3. Ensure all required ports are open and not in use by other services
|
||||
|
Loading…
Reference in New Issue
Block a user