Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/honza/smithy
A tiny git forge written in Go
https://github.com/honza/smithy
Last synced: about 6 hours ago
JSON representation
A tiny git forge written in Go
- Host: GitHub
- URL: https://github.com/honza/smithy
- Owner: honza
- License: gpl-3.0
- Created: 2020-11-20T01:27:28.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-16T18:44:20.000Z (about 2 years ago)
- Last Synced: 2024-08-10T11:02:35.799Z (3 months ago)
- Language: Go
- Homepage:
- Size: 158 KB
- Stars: 220
- Watchers: 9
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Smithy
===============================================================================
*smithy* (n) A blacksmith's shop; a forge.
Smithy is a web frontend for git repositories. It's implemented entirely in
Golang, compiles to a single binary, and it's fast and easy to deploy. Smithy
is an alternative to cgit or gitweb, and doesn't seek to compete with Gitea and
the like.
* Golang
* Single binary
* Easy to deploy
* Fast
* Customizable
* Free software
* Javascript-free
Building
-------------------------------------------------------------------------------
The only dependency is [Golang](https://golang.org/) 1.16 or higher.
Contributors to smithy should have the optional
[scdoc](https://sr.ht/~sircmpwn/scdoc) for generating documentation.
```
$ git clone https://github.com/honza/smithy
$ make
$ ./smithy --help
```
Installing
-------------------------------------------------------------------------------
We provide a make rule for installing/uninstall smithy. It will also install a
sample configuration file at `/usr/local/share/smithy/smithy.yml` that you can
later use as a guide.
```
$ make install
$ make uninstall
```
Configuration
-------------------------------------------------------------------------------
You can generate a sample configuration by issuing `make smithy.yml` command or
directly using the smithy binary:
```
$ make smithy.yml # will generate a smithy.yml file
$ smithy generate > config.yml
$ smithy serve --config config.yml
```
A sample configuration can be:
``` yaml
title: Smithy, a lightweight git forge
description: Publish your git repositories with ease
port: 3456
git:
root: "/var/www/git"
repos:
- path: "some-cool-project"
slug: "some-cool-project"
title: "Some Cool Project"
description: "Something really cool to change the world"
- path: "ugly-hacks"
exclude: true
static:
root:
prefix: /static/
templates:
dir:
```
Customizing templates and css
-------------------------------------------------------------------------------
Out of the box, smithy bundles templates and css in the binary. Setting
`static.root`, and `templates.dir` to empty string will cause smithy to use the
bundled assets.
If you'd like to customize the templates or the css, copy the `include`
directory somewhere, and then set `static.root`, and `templates.dir` to that
directory.
Demo
-------------------------------------------------------------------------------
Smithy is currently hosting [itself on my
domain](https://git.pokorny.ca/smithy).
Contributing
-------------------------------------------------------------------------------
Contributions are most welcome. You can open a pull request on
[GitHub](https://github.com/honza/smithy), or [email a patch][1] to
`[email protected]`.
[1]: https://git-send-email.io
License
-------------------------------------------------------------------------------
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see .