- Go 1.25. See https://go.dev/doc/manage-install
- node
- pnpm
Add custom/conf/app.ini. See details below for file content. Make sure to properly set WORK_PATH.
WORK_PATH = /path/to/forkana ; the only line which needs modification
[server]
PROTOCOL = http
DOMAIN = localhost
HTTP_PORT = 3000
ROOT_URL = http://localhost:3000/
RUN_MODE = dev
; LANDING_PAGE = explore
[database]
DB_TYPE = sqlite3
PATH = data/gitea.db
[security]
INSTALL_LOCK = true
SECRET_KEY = changeme
INTERNAL_TOKEN = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYmYiOjE3NTY3NDU2NjZ9.luRdwGyyCdO0dyjghYinzVgC7Uu8JXTlst2HkrjE80k
[oauth2]
JWT_SECRET = 9l225INhfQSZkuiCA1bu3rDvR3TDf6DckPy0m3qAGmE
[ui]
DEFAULT_THEME = gitea-light
EXPLORE_PAGING_DEFAULT_SORT = alphabeticallyThen run
$ pnpm installTo build the project:
$ TAGS="bindata sqlite sqlite_unlock_notify" make buildFor troubleshooting, see the details below:
Note that it might be necessary, depending on your system's configuration, to prepend a GO specification (indicating the name of the executable, if different from just go).
$ GO=go1.25.2 TAGS="bindata sqlite sqlite_unlock_notify" make buildAlso, in some situations, one might encounter a network connectivity issue with IPv6. The Go proxy is trying to connect over IPv6 and failing with "socket is not connected" errors. The solution is to modify the command by prefixing two additional vars:
$ GODEBUG="netdns=go+4" GOPROXY="direct" TAGS="bindata sqlite sqlite_unlock_notify" make buildDo the same for the following make watch command.
To run the project:
$ TAGS="sqlite sqlite_unlock_notify" make watchNote that you need to build once in any case, before running continuously with watch.
Finally, visit http://localhost:3000 and you are ready to go to fork with Forkana!
Note that the expectation is that you see the landing page of Forkana, not the database setup dialog of Gitea. If you see it, something went wrong. Using sqlite should prevent precisely this during initial setup.
Forkana includes tools to automatically populate your instance with content. For more information, see the details below:
Prior to running this command, make sure you have created an API token for your user. See the API token configuration guide for instructions.
The make populate command accepts the following environment variables:
GITEA_URL(required) - Your Forkana instance URLGITEA_TOKEN(required) - API token with repository creation permissionsARTICLE_COUNT(optional, default: 50) - Number of articles to fetchCATEGORY(optional) - Wikipedia category to fetch from (e.g., "Category:Physics")PRIVATE(optional, default: false) - Set to "true" to create private repositories
To populate your Forkana instance with 50 random Wikipedia articles:
GITEA_URL=http://localhost:3000 GITEA_TOKEN=your_api_token make populateFor more information about the individual tools:
- wiki2md - Fetch and convert Wikipedia articles to Markdown
- article-creator - Create Forkana repositories from Markdown files
To clean up
$ make clean-all
$ rm -rf data # to remove the sqlite databaseRun e2e tests
$ make test-e2e-sqliteRun all pgsql tests:
$ TEST_MINIO_ENDPOINT=localhost:9000 TEST_PGSQL_HOST=localhost:5432 TEST_PGSQL_DBNAME=test TEST_PGSQL_USERNAME=postgres TEST_PGSQL_PASSWORD=postgres make test-pgsqlRequires Docker containers gitea-pgsql and gitea-minio running.
$ docker run -d --name gitea-pgsql -e POSTGRES_DB=test -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres:14
$ docker run -d --name gitea-minio -e MINIO_ROOT_USER=123456 -e MINIO_ROOT_PASSWORD=12345678 -p 9000:9000 bitnamilegacy/minio:2023.8.31Run a single psql test (see details):
$ TEST_MINIO_ENDPOINT=localhost:9000 TEST_PGSQL_HOST=localhost:5432 TEST_PGSQL_DBNAME=test TEST_PGSQL_USERNAME=postgres TEST_PGSQL_PASSWORD=postgres make test-pgsql#TestJobWithNeeds
The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.
As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. This project has been forked from Gogs since November of 2016, but a lot has changed.
For online demonstrations, you can visit demo.gitea.com.
For accessing free Gitea service (with a limited number of repositories), you can visit gitea.com.
To quickly deploy your own dedicated Gitea instance on Gitea Cloud, you can start a free trial at cloud.gitea.com.
You can find comprehensive documentation on our official documentation website.
It includes installation, administration, usage, development, contributing guides, and more to help you get started and explore all features effectively.
If you have any suggestions or would like to contribute to it, you can visit the documentation repository
From the root of the source tree, run:
TAGS="bindata" make build
or if SQLite support is required:
TAGS="bindata sqlite sqlite_unlock_notify" make build
The build target is split into two sub-targets:
make backendwhich requires Go Stable, the required version is defined in go.mod.make frontendwhich requires Node.js LTS or greater and pnpm.
Internet connectivity is required to download the go and npm modules. When building from the official source tarballs which include pre-built frontend files, the frontend target will not be triggered, making it possible to build without Node.js.
More info: https://docs.gitea.com/installation/install-from-source
After building, a binary file named gitea will be generated in the root of the source tree by default. To run it, use:
./gitea web
Note
If you're interested in using our APIs, we have experimental support with documentation.
Expected workflow is: Fork -> Patch -> Push -> Pull Request
Note
- YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
- If you have found a vulnerability in the project, please write privately to [email protected]. Thanks!
Translations are done through Crowdin. If you want to translate to a new language, ask one of the managers in the Crowdin project to add a new language there.
You can also just create an issue for adding a language or ask on Discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty, but we hope to fill it as questions pop up.
Get more information from documentation.
We provide an official go-sdk, a CLI tool called tea and an action runner for Gitea Action.
We maintain a list of Gitea-related projects at gitea/awesome-gitea, where you can discover more third-party projects, including SDKs, plugins, themes, and more.
If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server or create a post in the discourse forum.
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
How do you pronounce Gitea?
Gitea is pronounced /ɡɪ’ti:/ as in "gi-tea" with a hard g.
Why is this not hosted on a Gitea instance?
We're working on it.
Where can I find the security patches?
In the release log or the change log, search for the keyword SECURITY to find the security patches.
This project is licensed under the MIT License. See the LICENSE file for the full license text.
