Redirector

Simple HTTP redirector with no dependencies
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With go and docker
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

I wanted a very simple HTTP redirector container that could take some env variables and have no depenencies as almost everything else I could find was based on NGINX and way over the top to configure.

(back to top)

Built With

• Go

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

You need GOLANG to build and test locally and a OCI compatible container builder to build the complete container.

• GOLANG
• OCI builder

Installation

1. Clone the repo

   git clone https://github.com/keifgwinn/redirector.git

2. go build for local development

   go build

3. docker build .

   docker build .

(back to top)

Usage

1. Set an ENV variable for REDIRECT_URL and REDIRECT_CODE

   export REDIRECT_URL = 'https://github.com/keifgwinn/redirector';
   export REDIRECT_CODE = '307';

2. Execute the program

   ./redirector

3. All in one line

    REDIRECT_URL='https://github.com/keifgwinn/redirector' REDIRECT_CODE=307 ./redirector

(back to top)

Roadmap

• Configurable port to listen on

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU License. See LICENSE.txt for more information.

(back to top)

Contact

Keif Gwinn - @keif - [email protected]

Project Link: https://github.com/keifgwinn/redirector

(back to top)

Acknowledgments

• This gist
• This answer

(back to top)