-
Notifications
You must be signed in to change notification settings - Fork 15
Adding Gitea to Awesome DevOps #22
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
5f6d119
e2a4601
dad74b7
af4b0f0
4b59050
2d037e2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,23 +1,103 @@ | ||||||
| # Gitea | ||||||
|
|
||||||
|  | ||||||
| <img src="../../logos/gitea.svg" alt="Gitea Logo" width="120"/> | ||||||
|
|
||||||
| ## Overview | ||||||
|
|
||||||
| Gitea is a lightweight, self-hosted Git service written in Go. It provides a simple and fast way to set up your own Git server, offering features like issue tracking, pull requests, and wiki pages. Gitea is designed to be easy to install and maintain, making it ideal for organizations that want to keep their code repositories private and under their control. | ||||||
| Gitea is a lightweight, self-hosted Git service written in Go. It provides a simple and fast way to set up your own Git server, offering features like issue tracking, pull requests, wiki pages, code review, collaboration features, a package registry and CI/CD via Gitea Actions. Gitea is designed to be easy to install and maintain, making it ideal for organizations that want to keep their code repositories private and under their control. | ||||||
|
|
||||||
| ## Key Features | ||||||
|
|
||||||
| - Feature 1 | ||||||
| - Feature 2 | ||||||
| - Feature 3 | ||||||
| - Git hosting & collaboration: repositories, branches/tags, web code browsing, and access control. | ||||||
| - Pull Requests & code review: review workflows with comments and merge support. | ||||||
| - CI/CD with Gitea Actions: GitHub Actions–compatible workflow approach. | ||||||
| - Package Registry: supports many package types for private/public artifact hosting. | ||||||
| - Fast and resource-efficient: designed to remain lightweight while supporting modern Git workflows. | ||||||
|
|
||||||
| ## Getting Started | ||||||
|
|
||||||
| Installation and basic usage instructions. | ||||||
| ### Prerequisites | ||||||
|
|
||||||
| Install Docker + Docker Compose v2 (Gitea’s docs note Compose v1 is deprecated; use Compose v2). | ||||||
|
|
||||||
| Create a working directory: | ||||||
|
|
||||||
| `mkdir gitea && cd gitea` | ||||||
| Create docker-compose.yml | ||||||
| ```yaml | ||||||
| version: "3" | ||||||
|
|
||||||
| networks: | ||||||
| gitea: | ||||||
| external: false | ||||||
|
|
||||||
| services: | ||||||
| server: | ||||||
| image: docker.gitea.com/gitea:1.25.3 | ||||||
| container_name: gitea | ||||||
| environment: | ||||||
| - USER_UID=1000 | ||||||
| - USER_GID=1000 | ||||||
| restart: always | ||||||
| networks: | ||||||
| - gitea | ||||||
| volumes: | ||||||
| - ./gitea:/data | ||||||
| - /etc/timezone:/etc/timezone:ro | ||||||
| - /etc/localtime:/etc/localtime:ro | ||||||
| ports: | ||||||
| - "3000:3000" | ||||||
| - "222:22" | ||||||
| ``` | ||||||
| Notes: | ||||||
| If you use host volumes, ensure the mapped folder is owned by the UID/GID you set, otherwise the container may not start. See https://docs.gitea.com/installation/docker/#volumes | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Convert bare URL to proper markdown link. The bare URL violates markdown linting rule MD034. Convert it to a proper markdown link for better formatting and compliance. 🔧 Proposed fix-If you use host volumes, ensure the mapped folder is owned by the UID/GID you set, otherwise the container may not start. See https://docs.gitea.com/installation/docker/#volumes
+If you use host volumes, ensure the mapped folder is owned by the UID/GID you set, otherwise the container may not start. See [volume documentation](https://docs.gitea.com/installation/docker/#volumes) for details.📝 Committable suggestion
Suggested change
🧰 Tools🪛 markdownlint-cli2 (0.18.1)54-54: Bare URL used (MD034, no-bare-urls) 🤖 Prompt for AI Agents |
||||||
| After first start, config will be written to /data/gitea/conf/app.ini | ||||||
| Start Gitea: | ||||||
| `docker-compose up -d` | ||||||
|
|
||||||
| Complete setup in the browser: | ||||||
| `http://<server-ip>:3000` | ||||||
|
|
||||||
| ### Option B: Install from Binary (Linux) | ||||||
|
|
||||||
| Download + install the binary: | ||||||
| ```bash | ||||||
| wget -O gitea https://dl.gitea.com/gitea/1.25.3/gitea-1.25.3-linux-amd64 | ||||||
| chmod +x gitea | ||||||
| sudo cp gitea /usr/local/bin/gitea | ||||||
| ``` | ||||||
| Prepare the environment | ||||||
| Check that Git is installed (Gitea requires Git >= 2.0): | ||||||
|
|
||||||
| ```bash | ||||||
| git --version | ||||||
| ``` | ||||||
|
|
||||||
| Create required directories: | ||||||
| ```bash | ||||||
| sudo mkdir -p /var/lib/gitea/{custom,data,log} | ||||||
| sudo chown -R git:git /var/lib/gitea | ||||||
| sudo chmod -R 750 /var/lib/gitea | ||||||
| sudo mkdir /etc/gitea | ||||||
| sudo chown root:git /etc/gitea | ||||||
| sudo chmod 770 /etc/gitea | ||||||
| ``` | ||||||
| run: | ||||||
| `GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini` | ||||||
|
|
||||||
| run as a service: | ||||||
| `sudo systemctl enable gitea --now` | ||||||
|
|
||||||
| ## Requirements | ||||||
| - Git: version >= 2.0 required. | ||||||
| - Database (choose one): PostgreSQL, MySQL, MariaDB, SQLite (built-in), or MSSQL. | ||||||
| - Recommended baseline (small teams): 2 CPU cores + 1GB RAM. | ||||||
|
|
||||||
| ## Resources | ||||||
|
|
||||||
| - [Official Website](https://example.com) | ||||||
| - [Documentation](https://docs.example.com) | ||||||
| - [GitHub Repository](https://github.com/example/Gitea) | ||||||
| - [Official Website](https://gitea.io/) | ||||||
| - [Documentation](https://docs.gitea.com/) | ||||||
| - [GitHub Repository](https://github.com/go-gitea/gitea) | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix the logo path to match directory nesting level.
The logo path uses
../../logos/gitea.svg, which resolves incorrectly for a direct subdirectory undertools/. Since this file is attools/Gitea/README.md, the correct relative path should be../logos/gitea.svg.As per coding guidelines: "Logo path resolution must account for nesting depth: tools/Category/Tool uses ../logos/, tools/Category/SubCategory/Tool uses ../../logos/"
🔧 Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents