1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
# Getting started with developing Gogs
> This document is driven from https://docs.sourcegraph.com/dev/local_development.
Gogs is written in [Go](https://golang.org/), please take [A Tour of Go](https://tour.golang.org/) if you haven't done so!
## Outline
- [Environment](#environment)
- [Step 1: Install dependencies](#step-1-install-dependencies)
- [Step 2: Initialize your database](#step-2-initialize-your-database)
- [Step 3: Get the code](#step-3-get-the-code)
- [Step 4: Configure database settings](#step-4-configure-database-settings)
- [Step 5: Start the server](#step-5-start-the-server)
- [Other nice things](#other-nice-things)
## Environment
Gogs is built and runs as a single binary and meant to be cross platform. Therefore, you should be able to develop Gogs in any major platforms you prefer.
## Step 1: Install dependencies
Gogs has the following dependencies:
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) (v1.8.3 or higher)
- [Go](https://golang.org/doc/install) (v1.13 or higher)
- [Less.js](http://lesscss.org/usage/#command-line-usage-installing)
- [GNU Make](https://www.gnu.org/software/make/)
- Database upon your choice (pick one, we choose PostgreSQL in this document):
- [PostgreSQL](https://wiki.postgresql.org/wiki/Detailed_installation_guides) (v9.6 or higher)
- [MySQL](https://dev.mysql.com/downloads/mysql/) with `ENGINE=InnoDB` (v5.7 or higher)
- [SQLite3](https://www.sqlite.org/index.html)
- [MSSQL](https://en.wikipedia.org/wiki/Microsoft_SQL_Server) (SQL Server 2005 or newer)
- [TiDB](https://github.com/pingcap/tidb)
### macOS
1. Install [Homebrew](https://brew.sh/).
1. Install dependencies:
```bash
brew install go postgresql git go-bindata npm
npm install -g less
npm install -g less-plugin-clean-css
```
1. Configure PostgreSQL to start automatically:
```bash
brew services start postgresql
```
1. Ensure `psql`, the PostgreSQL command line client, is on your `$PATH`.
Homebrew does not put it there by default. Homebrew gives you the command to run to insert `psql` in your path in the "Caveats" section of `brew info postgresql`. Alternatively, you can use the command below. It might need to be adjusted depending on your Homebrew prefix (`/usr/local` below) and shell (bash below).
```bash
hash psql || { echo 'export PATH="/usr/local/opt/postgresql/bin:$PATH"' >> ~/.bash_profile }
source ~/.bash_profile
```
### Ubuntu
1. Add package repositories:
```bash
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
```
1. Update repositories:
```bash
sudo apt-get update
```
1. Install dependencies:
```bash
sudo apt install -y make git-all postgresql postgresql-contrib golang-go nodejs
npm install -g less
# Watch out, it is not github.com/go-bindata/go-bindata!
go get -u github.com/kevinburke/go-bindata/...
```
1. Configure startup services:
```bash
sudo systemctl enable postgresql
```
## Step 2: Initialize your database
You need a fresh Postgres database and a database user that has full ownership of that database.
1. Create a database for the current Unix user:
```bash
# For Linux users, first access the postgres user shell
sudo su - postgres
```
```bash
createdb
```
2. Create the Gogs user and password:
```bash
createuser --superuser gogs
psql -c "ALTER USER gogs WITH PASSWORD '<YOUR PASSWORD HERE>';"
```
3. Create the Gogs database
```bash
createdb --owner=gogs --encoding=UTF8 --template=template0 gogs
```
## Step 3: Get the code
Generally, you don't need a full clone, so set `--depth` to `10`:
```bash
git clone --depth 10 https://github.com/gogs/gogs.git
```
**NOTE** The repository has Go Modules enabled, please clone to somewhere outside of your `$GOPATH`.
## Step 4: Configure database settings
Create a `custom/conf/app.ini` file inside the repository and put the following configuration (everything under `custom/` directory is used to override default files and is excluded by `.gitignore`):
```ini
[database]
DB_TYPE = postgres
HOST = 127.0.0.1:5432
NAME = gogs
USER = gogs
PASSWD = <YOUR PASSWORD HERE>
SSL_MODE = disable
```
## Step 5: Start the server
```bash
make web
```
You would have to re-run this command after changing Go files, or any file under `conf/`, `template/` and `public/` directories.
## Other nice things
### Load HTML templates and static files from disk
When you are actively working on HTML templates and static files during development, you may want to enable the following configuration to avoid recompiling and restarting Gogs every time you make a change to files under `template/` and `public/` directories:
```ini
[server]
LOAD_ASSETS_FROM_DISK = true
```
### Offline development
Sometimes you will want to develop Gogs but it just so happens you will be on a plane or a train or perhaps a beach, and you will have no WiFi. And you may raise your fist toward heaven and say something like, "Why, we can put a man on the moon, so why can't we develop high-quality Git hosting without an Internet connection?" But lower your hand back to your keyboard and fret no further, for the year is 2020, and you *can* develop Gogs with no connectivity by setting the following configuration in your `custom/conf/app.ini`:
```ini
[server]
OFFLINE_MODE = true
```
|