Add readme.md

2025-09-29 00:48:14 +03:00 · 2025-09-29 00:48:14 +03:00 · 2f2e638728
commit 2f2e638728
parent f9d733c637
1 changed files with 104 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@ -0,0 +1,104 @@
+# GitLab Docker Interactive Installer
+
+This repository contains an automated installation script for GitLab CE running inside a Proxmox LXC container with Docker.
+
+---
+
+## Features
+
+- Interactive prompts for essential configuration (admin email, SMTP, root password, LXC IP).
+- Automates Docker installation, container launch, and GitLab setup.
+- Automatically configures SMTP email for notifications.
+- Sets the initial root password as provided by the user.
+- Displays admin password and access instructions upon completion.
+
+---
+
+## Prerequisites
+
+- A Proxmox LXC container with a working Linux OS (Debian/Ubuntu recommended).
+- Network access to the container with a known IP.
+- Access to run commands with `sudo` inside the container.
+- An SMTP email account for sending GitLab notification emails.
+
+---
+
+## Installation Instructions
+
+1. **Download and run the installer script inside your LXC container**
+
+```
+curl -sSL https://your-server/path/install_gitlab.sh | sudo bash
+```
+
+2. **Enter the requested information:**
+
+- LXC container IP (used for informational purposes).
+- Admin email address (for system notifications).
+- SMTP email address and password.
+- SMTP server address and port (e.g. smtp.gmail.com and 465).
+- Initial root password for GitLab (must meet complexity requirements).
+
+3. **Wait for the script to complete**
+
+The script will install Docker and dependencies, pull the GitLab container, and start it with your settings.
+
+---
+
+## Post-install Access
+
+- Once initialized, access GitLab via the LXC container IP:
+
+```
+http://<LXC_CONTAINER_IP>
+```
+
+- Log in with username:
+
+```
+root
+```
+
+- And the initial root password you provided during installation.
+
+- It is strongly recommended to change the root password immediately after first login.
+
+---
+
+## Troubleshooting
+
+- Monitor container logs:
+
+```
+sudo docker logs -f gitlab
+```
+
+- If login fails, use the GitLab rails runner to reset the root password:
+
+```
+sudo docker exec -it gitlab gitlab-rails runner "user = User.where(id: 1).first; user.password = 'NEWPASSWORD'; user.password_confirmation = 'NEWPASSWORD'; user.save!"
+```
+
+---
+
+## License
+
+This installation script and README are provided as-is without warranty. Use at your own risk.
+
+---
+
+## Support
+
+For further GitLab usage and administration, refer to the official GitLab documentation:
+
+[https://docs.gitlab.com](https://docs.gitlab.com)
+
+[1](https://docs.gitlab.com/install/docker/installation/)
+[2](https://docs.gitlab.com/install/docker/)
+[3](https://gitlab.comp.dkit.ie/shawa/docker-install/-/blob/main/README.md)
+[4](https://gitlab.com/ton1czech/project-readme-template)
+[5](https://gitlab.c3s.unito.it/foswald/docker-example/-/blob/master/README.md)
+[6](https://gitlab.com/gitlab-org/omnibus-gitlab/-/blob/91c1a9e57224fd0fdde228c73f0847d9c861c772/doc/docker/README.md)
+[7](https://gitlab.com/gitlab-org/omnibus-gitlab/-/blob/da-geo-ha-upgrade-docs/doc/docker/README.md)
+[8](https://gitlab.com/gitlab-org/gitlab/-/blob/v13.0.13-ee/doc/ci/examples/README.md)
+[9](https://gitlab.cern.ch/sft/docker/-/blob/master/README.md)