diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cc7f7ab --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +examples/fastpastebin.yaml \ No newline at end of file diff --git a/README.md b/README.md index cce770f..39328a3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Fast Pastebin -Easy-to-use-and-install pastebin software written in Go. \ No newline at end of file +Easy-to-use-and-install pastebin software written in Go. + +# Installation and updating + +Just issue: + +``` +go get -u -v github.com/pztrn/fastpastebin +``` + +This command can be used to update Fast Paste Bin. + +# Configuration. + +Take a look at [example configuration file](examples/fastpastebin.yaml.dist) +which contains all supported options and their descriptions. + +Configuration file position is irrelevant, there is no hardcoded paths where +Fast Paste Bin looking for it's configuration. Use ``-config`` CLI parameter +or ``FASTPASTEBIN_CONFIG`` environment variable to specify path. \ No newline at end of file diff --git a/examples/fastpastebin.yaml b/examples/fastpastebin.yaml deleted file mode 100644 index 348457b..0000000 --- a/examples/fastpastebin.yaml +++ /dev/null @@ -1,26 +0,0 @@ -# Database configuration. -# Only MySQL database is supported for now. -database: - address: "localhost" - port: "3306" - username: "fastpastebin" - password: "fastpastebin" - database: "fastpastebin" - -# Logging configuration. -logging: - # Write log additionally to file? - log_to_file: false - # Log file name. - filename: "" - # Log level. Acceptable parameters: DEBUG, INFO, WARN, ERROR, FATAL, PANIC. - loglevel: "DEBUG" - -# HTTP server configuration. -http: - address: "192.168.0.14" - port: "25544" - # By default we're allowing only HTTPS requests. Setting this to true - # will allow HTTP requests. Useful for developing or if you're - # running Fast Pastebin behind reverse proxy that does SSL termination. - allow_insecure: true \ No newline at end of file