Removed old Docs

This commit is contained in:
Phil 2022-12-24 01:06:44 +01:00
parent 3eaa9aff82
commit fb4347eb7e
7 changed files with 0 additions and 117 deletions

View file

@ -1,27 +0,0 @@
# Binary installation
## Download
Get the newest binary build from the package registry.
- https://gitea.hackmi.ch/Phil/goshorly/-/packages
## Get dependencies
To get goshorly running you need redis.
Installation guide for Windows:
- https://developer.redis.com/create/windows/
Installation guide for Linux:
- https://redis.io/topics/quickstart (compile guide)
- https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-20-04-de (ubuntu/debian)
Installation guide for Darwin/OSX:
- https://developer.redis.com/create/homebrew/
## Run
Just run the executable in a Powershell (windows) or Terminal (linux/darwin)
### Configuration
#### .env File
To use the binary version you need to create an .env file in the directory.
Please see the [Environment List](../environment.md) for further details.

View file

@ -1,23 +0,0 @@
# Docker installation
## Available Docker tags
- https://gitea.hackmi.ch/Phil/goshorly/container_registry/1
## docker-compose (with no reverse proxy)
```bash
mkdir goshorly
cd goshorly
wget https://gitea.hackmi.ch/Phil/goshorly/-/raw/main/docker-compose.yml
nano docker-compose.yml # Change the environment variables to your needs
docker-compose up -d
```
## docker-compose (with builtin reverse proxy)
```bash
mkdir goshorly
cd goshorly
wget https://gitea.hackmi.ch/Phil/goshorly/-/raw/main/docker-compose-proxy.yml
mv docker-compose-proxy.yml docker-compose.yml
nano docker-compose.yml # Change the command line on caddy to your domain & environment variables to your needs
docker-compose up -d
```

View file

@ -1,8 +0,0 @@
# Environment
## You can use differnt environment variables with goshorly
### Use env with docker or .env file
| ENV NAME | DESC. | VALUES |
|---- |--- |--- |

View file

@ -1,21 +0,0 @@
# Welcome to goshorly
goshorly is an easy to use and self-hostable link shortener. It is based on the Golang programming language. Redis is used as the database.
If you have an feature request, please do not hesitate to open an issue or merge request.
**WARNING:**
- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X)
## Disclaimer
This site is work in progress and does not contain the full docs.
## Supported architectures
### Docker
- amd64, arm64
- other versions can be build manually (via docker build / buildx)
### Binary Build
- linux (amd64,arm64)
- darwin (amd64,arm64)
- windows (amd64)
- other versions can be build manually (via go build)

View file

@ -1,2 +0,0 @@
mkdocs
mkdocs-material

View file

@ -1,15 +0,0 @@
site_name: goshorly docs
site_url: https://phil.mekelek.de/goshorly
repo_url: https://gitea.hackmi.ch/Phil/goshorly
site_dir: public
theme:
name: material
locale: en
highlightjs: true
nav:
- Home: 'index.md'
- Installation:
- Docker: 'deploy/docker.md'
- Binary: 'deploy/binary.md'
- Environment: 'environment.md'

View file

@ -1,21 +0,0 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"packageRules": [
{
"matchUpdateTypes": ["minor", "patch", "pin", "digest"],
"automerge": true
}
],
"vulnerabilityAlerts": {
"labels": ["critical"],
"assignees": ["@Phil"]
},
"extends": [
"config:base",
":preserveSemverRanges",
":dependencyDashboard",
":rebaseStalePrs",
":enableVulnerabilityAlertsWithLabel('critical')"
],
"commitBody": "[skip ci]"
}