Project transfered to https://codeberg.org/yomli/ygg
🗂️ File explorer for git projects hosted on your own server.
Your own read-only minimal GitHub! Gitlist is cool, but it requires git, and therefore a lot of memory. This one does many of the features of GitHub|list, in about 40 KB of a single file. The beauty of it is that it doesn't even need git, so you can update you code the way you like. A webhook support is provided below.
A demo is here, so you can see Ygg showing it's own source code (and that's meta).
- File explorer
- 🆕 Universal syntax highlight
- Releases tab
- Download the entire project or just one file
- Raw view
- Fuzzy search to find a file
- 🆕 Share the line by clicking the line number
- 🆕 Dark mode
- RSS feed
- Customizable
- Apache with
mod_rewrite - PHP 7.4+
- PHP
zipextension - PHP
jsonextension
Just drop the index.php file in a directory containing a bunch of folders.
wget https://raw.githubusercontent.com/yomli/ygg/master/index.php
In its default state, Ygg will use the master folder as its index (the "Code" tab on GitHub) if it exists, else it will show the content of the releases folder. Configure Ygg if you want others folders to be browseable. Then open Ygg in your favorite browser so it can create the necessary .htaccess.
You may have to edit some variables placed in the first lines of index.php. Alternatively, you can just drop a config.json file in the same directory, and it will override the default values:
{
"title": "My cool project",
"nav": {
"browseable": {
"Code": "src",
"Releases": "releases"
},
"links": {
"Help": "docs",
"Fork me here": "https://github.com/name/repo"
}
}
}By default, README files are rendered in plaintext. You can change that by editing the path to a Parsedown.php file:
'parsedown' => '/assets/php/Parsedown.php' // Path to the Parsedown.php parser (for readme parsing)
By default, text files are rendered by a tiny universal syntax highlighter. By its nature, it's prone to error. You can change the syntax highlighter by editing the variables of the syntax_highlighter array:
'syntax_highlighter' => [
'css' => '/assets/css/Prism.css', // Path to the css of the syntax highlighter you use
'js' => '/assets/js/Prism.js', // Path to the js of the syntax highlighter you use
'strip_numbers' => false // Do not show the numbers (ie, if using a Prism.js' plugin)
]
URLs can be absolute or relative to the index.php file.
Just place a favicon.ico file in your directory, and set custom_favicon to true.
Any text contained in the alert.txt file in your directory will be displayed on top of the file explorer. It's useful if you want to show the latest commit gotten by a webhook or a RSS parser script on your server.
Since it's just one file, you can symlink it into any project directory, using for each one a custom config.json.
When you clone a repository on your computer, a folder called .git is created. If you upload this folder into, say, /master, and if your webhost permits it, you can place a simple php script alongside ygg:
<?php
if (isset($_GET["my-super-duper-secret-key"])) {
# Don't cache ourself
header("Cache-Control: max-age=1");
error_reporting(E_ALL);
ini_set("display_errors", 1);
$path = (!empty($_GET["p"])) ? trim(urldecode($_GET["p"]), DIRECTORY_SEPARATOR) : "master";
chdir(__DIR__ . DIRECTORY_SEPARATOR . $path);
# Uncomment the following 2 lines if you want to "force pull"
//shell_exec("git fetch --all");
//shell_exec("git reset --hard HEAD");
$output = shell_exec("git pull");
echo "<pre>$output</pre>";
}
exit();This way, in GitHub, you can add a webhook for every commit to https://my-domain.tld/my-pull-script.php?my-super-duper-secret-key. Every time you commit your code on GitHub, the repository on your web hosting will be updated.
Licensed under the terms of the MIT license. See the LICENSE file for license rights and limitations.
- Inspired by Minixed.
- SVG icons from IconSVG, Icomoon and Octicons, converted using https://yoksel.github.io/url-encoder/
- Favicon by smalllikeart from www.flaticon.com