diff --git a/README.md b/README.md index e4696b7..c7fbb64 100644 --- a/README.md +++ b/README.md @@ -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. @@ -16,13 +16,9 @@ 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 @@ -30,6 +26,18 @@ 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: @@ -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) \ No newline at end of file diff --git a/assets/admin.png b/assets/admin.png index e5a4a41..7c69dac 100644 Binary files a/assets/admin.png and b/assets/admin.png differ diff --git a/assets/index.png b/assets/index.png index 85f2016..6ddec5d 100644 Binary files a/assets/index.png and b/assets/index.png differ diff --git a/assets/wait.png b/assets/wait.png new file mode 100644 index 0000000..905ff28 Binary files /dev/null and b/assets/wait.png differ diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index 82c19cf..4235363 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -9,8 +9,6 @@ services: image: redir:latest environment: REDIR_CONF: ./data/redirconf.yml - ports: - - "8080:80" depends_on: - mongo deploy: diff --git a/test.json b/test.json deleted file mode 100644 index 2ca2d88..0000000 --- a/test.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "op": "create", - "alias": "awesome-link", - "data": { - "alias": "awesome-link", - "url": "https://github.com/changkun", - "private": true, - "valid_from": "2022-01-01T00:00:00+00:00" - } -} \ No newline at end of file