{"id":21992726,"url":"https://github.com/pinpox/gopherlix","last_synced_at":"2025-03-23T03:41:32.026Z","repository":{"id":57572807,"uuid":"236516684","full_name":"pinpox/gopherlix","owner":"pinpox","description":"A Server for the Gopher protocol written in Go","archived":false,"fork":false,"pushed_at":"2020-02-01T09:21:06.000Z","size":132,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-28T10:17:58.324Z","etag":null,"topics":["go","golang","gopher","gopher-protocol","gopher-server","server"],"latest_commit_sha":null,"homepage":"https://pablo.tools","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pinpox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-27T15:02:31.000Z","updated_at":"2023-01-15T06:35:03.000Z","dependencies_parsed_at":"2022-08-30T09:01:13.841Z","dependency_job_id":null,"html_url":"https://github.com/pinpox/gopherlix","commit_stats":null,"previous_names":["binaryplease/gopherlix","binaryplease/gopher-server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinpox%2Fgopherlix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinpox%2Fgopherlix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinpox%2Fgopherlix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinpox%2Fgopherlix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pinpox","download_url":"https://codeload.github.com/pinpox/gopherlix/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245052637,"owners_count":20553162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","golang","gopher","gopher-protocol","gopher-server","server"],"created_at":"2024-11-29T20:14:42.693Z","updated_at":"2025-03-23T03:41:32.007Z","avatar_url":"https://github.com/pinpox.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n[![Build Status](https://travis-ci.org/binaryplease/gopherlix.svg?branch=master)](https://travis-ci.org/binaryplease/gopherlix)\n[![GoDoc](https://godoc.org/github.com/binaryplease/gopherlix?status.svg)](https://godoc.org/github.com/binaryplease/gopherlix)\n[![Go Report Card](https://goreportcard.com/badge/github.com/binaryplease/gopherlix)](https://goreportcard.com/report/github.com/binaryplease/gopherlix)\n[![codecov](https://codecov.io/gh/binaryplease/gopherlix/branch/master/graph/badge.svg)](https://codecov.io/gh/binaryplease/gopherlix)\n\n\n# gopherlix\n\nA Server for the Gopher protocol, written in the Go.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./logo.png\"\u003e\n\u003c/p\u003e\n\n## Usage\n\n### Quickstart\n\n#### Installation\n\nJust clone the repository and run `go build` in it.\n\n```sh\ngit clone https://github.com/binaryplease/gopherlix.git\ncd gopherlix\ngo build\n```\n\n#### Basic configuration\n\n```ini\n[paths]\ncontent = \"data/content\"\ntemplates = \"data/templates\"\n\n[server]\nport = \"8000\"\ndomain = \"localhost\"\nhost = \"0.0.0.0\"\n```\n\nThe configuration file (`config.ini`) should be self explanatory. The server\nincludes some sample pages and should run with it out of the box on port `8000`.\nYou may want to change the port to gophers default port `70`\n\n#### Run the server\n\nGopherlix will look for the configuration file in the same folder as the server\nper defalt.\n\nTo start it just run `./gopherlix` and start browsing `goopher://localhost:8000`\n\n\n### Features\n\n#### Adding content\n\nYou can add content in the `content` directory configured in `config.ini`.\nThe `templates` directory includes templates that can be rendered in inside\nother files. The `header.gph` and `footer.gph` will be added automatically to\nall pages.\n\n\n#### Directory listings\n\nA request like `gopher://localhost/something` will look for\n`data/content/something` and check if it's a file or a directory.\nFor a file, the contents of it will be returned. If the requested path is a\ndirectory, it will try to find a file called `index.gph` in it and display it.\n\nIf no `index.gph` is found in this directory, it will generate a listing with\nlinks to all the directory contents.\n\n#### Templating\n\nGopherlix leverages the power of golangs\n[templates](https://golang.org/pkg/text/template/) to generate content\ndynamically. This allows to include ariables in the form of `{{.Variablename}}`\nin any page that will be replaced accordingly. At the moment the following\nvariables are suported (more to come in future updates):\n\n| Variable        | Description                    |\n|-----------------|--------------------------------|\n| {{.Directory}}  | Path of the current request    |\n| {{.ServerName}} | Shows the server's domain name |\n\n# Contributing\n\nPull-request, issues, feature-requst and contributions of any kind are *very*\nwelcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinpox%2Fgopherlix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpinpox%2Fgopherlix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinpox%2Fgopherlix/lists"}