gohost

README

gohost

a tiny, single user, sharex compatible file host built in Go


· Report Bug · Request Feature

Table of Contents

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

About The Project

Built With

• Fiber

(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.

Installation

1. Clone the repo

   git clone https://github.com/evwltrs/gohost.git
   

2. Install packages

   go get
   

3. Enter your input your hostname and SECRET api key in .env

   API_KEY = "changeme"
   HOSTNAME = "http://127.0.0.1:3000"
   

(back to top)

Usage

1. Generate a ShareX config (optional)

   go run ./sharex
   

2. Build your executable

   go build
   

3. Run your executable

   ./gohost --port=:3000
   

   For production enable prefork for multiple processes

   ./gohost --port=:3000 --prod=true
   

(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 MIT License. See LICENSE.txt for more information.

(back to top)

Contact

1nf - @evancodes - ev@1nf.me

Project Link: https://github.com/evwltrs/gohost

(back to top)