gitea-installer.sh/README.md

131 lines
4.6 KiB
Markdown
Raw Normal View History

2017-10-25 23:07:47 +00:00
# Gitea Installer
2018-07-26 20:39:18 +00:00
Installs [Gitea](https://gitea.io) (formerly Gogs) as a systemd service
2018-06-04 21:33:56 +00:00
2018-08-08 01:02:04 +00:00
# Easy Install (Linux)
2018-06-04 21:33:56 +00:00
2018-07-26 20:39:18 +00:00
You can download and run the installer script using this command:
2017-10-25 23:07:47 +00:00
2018-06-28 18:41:39 +00:00
`curl -fsSL https://git.coolaj86.com/coolaj86/gitea-installer.sh/raw/branch/master/install.bash | bash`
2017-10-28 00:13:57 +00:00
2018-08-20 23:52:18 +00:00
<a href="https://youtu.be/dTvTBlzKqgg" target="_blank"><img title="How to install Gitea" alt="a screencast of me installing gitea and migrating one of my github repos" src="https://i.imgur.com/e4CZdBu.png"></a>
2018-08-20 23:52:18 +00:00
## Specific Versions
2018-08-08 01:02:04 +00:00
2018-08-20 23:52:18 +00:00
You can pick a specific version to install. For example, if you were nostalgic for 1.2.0, you could run:
2018-08-08 01:02:04 +00:00
2018-08-20 23:52:18 +00:00
`curl -fsSL https://git.coolaj86.com/coolaj86/gitea-installer.sh/raw/branch/master/install.bash | bash -s version 1.2.0`
2018-08-08 01:02:04 +00:00
# After Installing
2018-07-26 20:39:18 +00:00
Once you have gitea installed and running you must choose
which database to use, certain gitea paths, an admin user, etc.
Go to: http://localhost:3000/
2018-08-21 00:40:14 +00:00
You should see these fields:
*The following is for basic usage with this script, for more advance usage see: [https://docs.gitea.io/en-us/customizing-gitea/](https://docs.gitea.io/en-us/customizing-gitea/)*
2018-08-21 00:37:34 +00:00
`Database Type:` Use SQLite3 for the database.
`Path:` Leave this alone.
`Application Name:` Give your Gitea server a fancy name.
`Repository Root Path:` Leave this alone.
`LFS Root Path:` Leave this alone.
`Run User:` Leave this alone.
`Domain:` Replace this with your domain name for the server.
`SSH Port:` Leave this alone unless you want a custom port for SSH.
`HTTP Port:` Change this if you want Gitea to serve on a different port. You don't usually need to, Gitea is usually used behind a web server.
`Application URL:` Enter the full URL for your Gitea instance, like https://example.com/
`Log Path:` Leave this alone.
Click on "Admin Account Settings" to setup your user account and click "Install Gitea" when you are done.
2018-07-26 20:39:18 +00:00
## Manual Install
2018-07-26 20:39:18 +00:00
2017-10-28 00:13:57 +00:00
Or manually install by reading these instructions and following along:
```bash
### Create a 'gitea' user and group with the home /opt/gitea, no password (because it's a system user) and no GECOS
2017-10-28 00:13:57 +00:00
sudo adduser gitea --home /opt/gitea --disabled-password --gecos ''
2017-10-25 23:07:47 +00:00
### Make some other potentially useful directories for that user/group
2017-10-25 23:33:34 +00:00
sudo mkdir -p /opt/gitea/ /var/log/gitea
sudo chown -R gitea:gitea /opt/gitea/ /var/log/gitea
2017-10-25 23:07:47 +00:00
### Download and install gitea. Replace "amd64" with "i386" for 32 bit x86 or "arm-7" for ARMv7 and "arm-6" for ARMv6.
2018-05-29 19:55:51 +00:00
sudo wget -O /opt/gitea/gitea https://dl.gitea.io/gitea/1.4.1/gitea-1.4.1-linux-amd64
2017-10-28 00:13:57 +00:00
sudo chmod +x /opt/gitea/gitea
2017-10-25 23:07:47 +00:00
### Download and install the gitea.service for systemd
2017-11-10 17:49:50 +00:00
sudo wget -O /etc/systemd/system/gitea.service https://git.coolaj86.com/coolaj86/gitea-installer.sh/raw/master/dist/etc/systemd/system/gitea.service
2017-10-25 23:07:47 +00:00
### Start gitea
2017-10-25 23:07:47 +00:00
sudo systemctl restart gitea
```
2018-07-26 20:39:18 +00:00
Then see the post-install instruction above.
2017-10-28 05:27:16 +00:00
2018-03-26 06:32:53 +00:00
## Customize Gitea
```
/opt/gitea/custom/conf/app.ini
https://github.com/go-gitea/gitea/tree/master/custom/conf/app.ini.sample
```
2018-08-20 14:58:54 +00:00
Once a reverse proxy is set up you can change the `HTTP_ADDR` from the default (world accessible) to localhost-only.
```
HTTP_ADDR = localhost
```
2018-03-26 06:08:55 +00:00
## Customize Gitea Theme
All overrides to the existing theme can be placed in the `custom/public` and `custom/templates` folders.
2018-03-27 06:12:03 +00:00
* Change Logo
* Change Landing Page
* Google Analytics
2018-03-26 06:08:55 +00:00
```
/opt/gitea/custom/public
/opt/gitea/custom/templates
2018-03-26 06:32:53 +00:00
/opt/gitea/custom/public/img/favicon.png # 16x16 logo in tab
/opt/gitea/custom/public/img/gitea-sm.png # 120x120 logo on all pages
/opt/gitea/custom/public/img/gitea-sm.png # 880x880 logo on landing page
/opt/gitea/custom/templates/home.tmpl # The landing page
2018-08-20 15:24:38 +00:00
/opt/gitea/custom/templates/base/head.tmpl # Google Analytics, Login with Github
2018-03-26 06:08:55 +00:00
```
2018-08-20 15:24:38 +00:00
* [Login with Github](https://git.coolaj86.com/coolaj86/gitea-installer.sh/src/tag/v1.0.0/custom/templates/base/head.tmpl#L277)
2018-03-26 06:08:55 +00:00
For many items, such as the logo, you can simply right-click "inspect" to discover the location. For example, the small logo is `/img/gitea-sm.png` or `/opt/gitea/custom/public/img/gitea-sm.png`.
You can find more information about customization and templates in the docs and on github:
* https://docs.gitea.io/en-us/customizing-gitea/
* https://github.com/go-gitea/gitea/tree/master/templates/
2018-05-29 19:55:51 +00:00
2017-11-14 14:49:16 +00:00
# Troubleshooting systemd
2017-10-25 23:07:47 +00:00
See [Troubleshooting systemd](https://git.coolaj86.com/coolaj86/service-installer.sh/src/master/README.md#troubleshooting-systemd)
# Removing Gitea
Run this command to uninstall Gitea: (THIS WILL REMOVE ALL DATA if you are using SQLite!)
`curl -fsSL https://git.coolaj86.com/coolaj86/gitea-installer.sh/raw/branch/master/remove.bash | bash`