Skip to content

Commit

Permalink
all: doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
changkun committed Mar 24, 2021
1 parent 5350389 commit 93cd8e8
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 19 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# redir [![PkgGoDev](https://pkg.go.dev/badge/changkun.de/x/redir)](https://pkg.go.dev/changkun.de/x/redir) ![](https://changkun.de/urlstat?mode=github&repo=changkun/redir)
# redir [![Latest relsease](https://img.shields.io/github/v/tag/changkun/redir?label=latest)](https://github.com/changkun/redir/releases) [![PkgGoDev](https://pkg.go.dev/badge/changkun.de/x/redir)](https://pkg.go.dev/changkun.de/x/redir) ![](https://changkun.de/urlstat?mode=github&repo=changkun/redir)

Self-hosted link shortener and request redirector.

Expand All @@ -16,20 +16,28 @@ Self-hosted link shortener and request redirector.
- **Privacy**: GDPR friendly
- ... and more

## Web
## Web Interfaces

### Public Indexes

Router: `/s` or `/r`

![](./assets/index.png)
There are three major pages available in redir.

### Admin Dashboard

Router: `/s?mode=admin` or `/r?mode=admin`

![](./assets/admin.png)

### Accessible Control

Control if a link should only be available after a certain time point:

![](./assets/wait.png)

### Public Indexes

Router: `/s` or `/r`

![](./assets/index.png)

## CLI Usage

The `redir` command offers server side operation feature from shell:
Expand Down Expand Up @@ -167,6 +175,11 @@ from it and has a different architecture and feature set now.

To know more users, check our [wiki](https://github.com/changkun/redir/wiki) page.

## Contributing

Easiest way to contribute is to provide feedback! We would love to hear
what you like and what you think is missing. PRs are also welcome.

## License

MIT © 2020-2021 [Changkun Ou](https://changkun.de)
Binary file modified assets/admin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/wait.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ services:
image: redir:latest
environment:
REDIR_CONF: ./data/redirconf.yml
ports:
- "8080:80"
depends_on:
- mongo
deploy:
Expand Down
10 changes: 0 additions & 10 deletions test.json

This file was deleted.

0 comments on commit 93cd8e8

Please sign in to comment.