commit 92a53aa6315509908e770124b37fbd9bfd9b4e8b
Author: root <root@vultr.guest>
Date:   Sun Mar 23 16:13:31 2025 +0000

    first commit

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5920a3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# Docker-Compose-Gitea
+
+A Docker Compose file for Gitea - Git with a cup of tea ([gitea.io](https://gitea.io))
+
+Data will be saved in separate docker volumes to enable easy upgrades!
+
+## Requirements
+
+* docker
+* docker-compose
+
+## Getting Started
+
+1. Copy **.env.dist** to **.env** and make your modifications
+2. Start docker containers:
+```
+$ docker-compose up -d
+```
+
+After that open gitea installer via browser: [http://localhost:3000](http://localhost:3000) and fill the form according your .env settings. 
+
+Set **`gitea-db:3306`** in _Host_ field and complete setup.
+
+After setup is completed register a new user (use link from the navigation bar).
+
+The first registered user has admin privileges.
+
+
+### Environment Configuration
+
+| VARIABLE              | Description                       | DEFAULT       |
+| ----------------------|-----------------------------------|:-------------:|               
+|GITEA_VERSION          | Docker-Image-Version              |latest         |
+|GITEA_HOSTNAME         | Hostname for Gitea Application    |localhost      |
+|GITEA_WEB_PORT         | GUI-Port for accessing Gitea      |3000           |
+|GITEA_SSH_PORT         | Port for accessing Gitea via SSH  |2222           |
+|MYSQL_ROOT_PASSWORD    | MySQL root password               |root           |
+|MYSQL_DATABASE         | Database name for gitea           |gitea          |
+|MYSQL_USER             | Database user for gitea           |gitea          |
+|MYSQL_PASSWORD         | Password for MySQL user           |gitea          |
+
+
+## Create systemd unit
+1. Copy **docker-gitea.service.dist** to **docker-gitea.service**
+1. Adjust **WorkingDirectory** in service file if needed
+1. Create symbolic link: ``ln -s docker-gitea.service /etc/systemd/system/docker-gitea.service``
+1. Start service: ``systemctl start docker-gitea``
+1. (optional) Enable autostart at boot: ``systemctl enable docker-gitea``