[{"_1":2,"_176":-5,"_177":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_151":152},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_89":-5,"_90":91,"_140":-5,"_141":11,"_142":21,"_143":11,"_144":-5,"_145":11,"_146":-5,"_147":148,"_149":92,"_150":-7},"canonicalUrl","https://hub.docker.com/r/m3ng9i/ran/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","m3ng9i","reponame","ran","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":69,"_70":71,"_72":11,"_73":33,"_74":75,"_80":11,"_81":82,"_86":33,"_87":88},"categories",[],"content_types",[44],"image","date_registered","2020-01-31T07:02:21.435585Z","description","a simple static web server","is_private","last_updated","2020-06-27T07:54:07.939933Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",663927,"repository_type","star_count",4,"status",1,"status_description","active","source","collaborator_count",0,"full_description","Ran: a simple static web server written in Go\n=============================================\n\n![Ran](https://raw.githubusercontent.com/m3ng9i/ran/master/ran.gif)\n\nRan is a simple web server for serving static files.\n\n- Github: \n- Docker Hub: \n\n## Features\n\n- Directory listing\n- Automatic gzip compression\n- Digest authentication\n- Access logging\n- Custom 401 and 404 error file\n- TLS encryption\n- Disable content caching\n- Write cross-origin resource sharing headers to the response\n\n## What is Ran for?\n\n- File sharing in LAN or home network\n- Web application testing\n- Personal web site hosting or demonstrating\n\n## Dependencies\n\n- [github.com/abbot/go-http-auth](https://github.com/abbot/go-http-auth)\n- [github.com/oxtoacart/bpool](https://github.com/oxtoacart/bpool)\n- [github.com/m3ng9i/go-utils/http](https://github.com/m3ng9i/go-utils)\n- [github.com/m3ng9i/go-utils/log](https://github.com/m3ng9i/go-utils)\n- [github.com/m3ng9i/go-utils/possible](https://github.com/m3ng9i/go-utils)\n- [golang.org/x/net/context](https://github.com/golang/net)\n\n## Installation\n\nUse the command below to install the dependencies mentioned above, and build the binary into $GOPATH/bin.\n\n```bash\ngo get -u github.com/m3ng9i/ran\n```\n\nFor convenience, you can move the ran binary to a directory in the PATH environment variable.\n\nYou can also call `./build.py` command under the Ran source directory to write version information into the binary, so that `ran -v` will give a significant result. Run `./build.py -h` for help.\n\n### Running with Docker\n\n```bash\ndocker run -d -p 8080:8080 -v /public:/web m3ng9i/ran\n```\n\nDirectory volume mounted to `/web` will be served by default.\n\nBelow is another example, the options `-l -404 /404page.html` are passed to the `ran` binary:\n\n```bash\ndocker run --name ran -d -p 8080:8080 -v /public:/web:ro m3ng9i/ran -l -404 /404page.html\n```\n\n## Download binary\n\nYou can also download the Ran binary without building it yourself.\n\n[Download Ran binary from the release page](https://github.com/m3ng9i/ran/releases).\n\n## Run Ran\n\nYou can start a web server without any options by typing `ran` and pressing return in terminal window. This will use the following default configuration:\n\nConfiguration | Default value\n----------------------------|--------------------------------\nRoot directory | the current working directory\nIP binding | 0.0.0.0\nPort | 8080\nIndex file | index.html, index.htm\nList files of directories | false\nServe all path | false\nGzip | true\nDisable caching | false\nWrite cross-origin headers | false\nDigest auth | false\nTLS encryption | off\n\nOpen http://127.0.0.1:8080 in browser to see your website.\n\nYou can use the command line options to override the default configuration.\n\nOptions:\n\n```\n -r, -root= Root path of the site. Default is current working directory.\n -b, -bind-ip= Bind one or more IP addresses to the ran web server.\n Multiple IP addresses should be separated by comma.\n If not provide this Option, ran will use 0.0.0.0.\n -p, -port= HTTP port. Default is 8080.\n -404= Path of a custom 404 file, relative to Root. Example: /404.html.\n -i, -index= File name of index, priority depends on the order of values.\n Separate by colon. Example: -i \"index.html:index.htm\"\n If not provide, default is index.html and index.htm.\n -l, -listdir= When request a directory and no index file found,\n if listdir is true, show file list of the directory,\n if listdir is false, return 404 not found error.\n Default is false.\n -sa, -serve-all= Serve all paths even if the path is start with dot. Default is false.\n -g, -gzip= Turn on or off gzip compression. Default value is true (means turn on).\n\n -nc, -no-cache= If true, ran will remove Last-Modified header and write some no-cache headers to the response:\n Cache-Control: no-cache, no-store, must-revalidate\n Pragma: no-cache\n Expires 0\n Default is false.\n\n -cors= If true, ran will write some cross-origin resource sharing headers to the response:\n Access-Control-Allow-Origin: *\n Access-Control-Allow-Credentials: true\n Access-Control-Allow-Methods: *\n Access-Control-Allow-Headers: *\n If the request header has a Origin field, then it's value is used in Access-Control-Allow-Origin.\n Default is false.\n\n -am, -auth-method= Set authentication method, valid values are basic and digest. Default is basic.\n -a, -auth= Turn on authentication and set username and password (separate by colon).\n After turn on authentication, all the page require authentication.\n -401= Path of a custom 401 file, relative to Root. Example: /401.html.\n If authentication fails and 401 file is set,\n the file content will be sent to the client.\n\n -tls-port= HTTPS port. Default is 443.\n -tls-policy= This option indicates how to handle HTTP and HTTPS traffic.\n There are three option values: redirect, both and only.\n redirect: redirect HTTP to HTTPS\n both: both HTTP and HTTPS are enabled\n only: only HTTPS is enabled, HTTP is disabled\n The default value is: only.\n -cert= Load a file as a certificate.\n If use with -make-cert, will generate a certificate to the path.\n -key= Load a file as a private key.\n If use with -make-cert, will generate a private key to the path.\n```\n\nOther options:\n\n```\n -make-cert Generate a self-signed certificate and a private key used in TLS encryption.\n You should use -cert and -key to set the output paths.\n -showconf Show config info in the log.\n -debug Turn on debug mode.\n -v, -version Show version information.\n -h, -help Show help message.\n```\n\nIf you want to shutdown Ran, type `ctrl+c` in the terminal, or kill it in the task manager.\n\n### Examples\n\nExample 1: Start a server in the current directory and set port to 8888\n\n```bash\nran -p=8888\n```\n\nExample 2: Set root to /tmp, list files of directories and set a custom 404 page\n\n```bash\nran -r=/tmp -l=true -404=/404.html\n```\n\n`-l=true` can be shorted to `-l` for convenience.\n\nExample 3: Turn off gzip compression, set access username and password and set a custom 401 page\n\n```bash\nran -g=false -a=user:pass -401=/401.html\n```\n\nExample 4: Set custom index file\n\n```bash\nran -i default.html:index.html\n```\n\nExample 5: Turn on TLS encryption\n\nIf you want to turn on TLS encryption (https), you should use `-cert` to load a certificate and `-key` to load a private key.\n\nThe default TLS port is 443, you can use `-tls-port` to set it to another port.\n\nThe following command load a certificate and a private key, and set TLS port to 9999. It can be browsed at https://127.0.0.1:9999.\n\n```bash\nran -cert=/path/to/cert.pem -key=/path/to/key.pem -tls-port=9999\n```\n\nExample 6: Control HTTP and HTTPS traffic\n\nWhen you turn on TLS, you can choose to disable HTTP, redirect HTTP to HTTPS or let them work together.\n\nYou can use `-tls-policy` to control HTTP and HTTPS traffic:\n\n- If set to \"redirect\", all HTTP traffic will be redirect to HTTPS.\n- If set to \"both\", both HTTP and HTTPS are enabled.\n- If set to \"only\", only HTTPS is enabled, HTTP is disabled.\n\nIf not provide `-tls-policy`, the default value \"only\" will be used.\n\nAn example:\n\n```bash\nran -cert=cert.pem -key=key.pem -tls-policy=redirect\n```\n\nExample 7: Create a self-signed certificate and a private key\n\nFor testing purposes or internal usage, you can use `-make-cert` to create a self-signed certificate and a private key.\n\n```bash\nran -make-cert -cert=/path/to/cert.pem -key=/path/to/key.pem\n```\n\nExample 8: Custom IP binding\n\n```bash\nran -b=127.0.0.12,192.168.0.34\n```\n\n## Tips and tricks\n\n### Execute permission\n\nBefore running Ran binary or build.py, make sure they have execute permission. If don't, use `chmod u+x ` to set.\n\n### download parameter\n\nIf you add `download` as a query string parameter in the url, the browser will download the file instead of displaying it in the browser window. Example:\n\n```\nhttp://127.0.0.1:8080/readme.html?download\n```\n\n### gzip parameter\n\nGzip compression is enabled by default. Ran will gzip file automaticly according to the file extension. Example: a `.txt` file will be compressed and a `.jpg` file will not.\n\nIf you add `gzip=true` in the url, Ran will force compress the file even if the file should not be compressed. Example:\n\n```\nhttp://127.0.0.1:8080/picture.jpg?gzip=true\n```\n\nIf you add `gzip=false` in the url, Ran will not compress it even if it should be compressed. Example:\n\n```\nhttp://127.0.0.1:8080/large-file.txt?gzip=false\n```\n\nRead the source code of [CanBeCompressed()](https://github.com/m3ng9i/go-utils/blob/master/http/can_be_compressed.go) to learn more about automatic gzip compression.\n\n## Changelog\n\n- **v0.1.5**:\n\n - Add `-b, -bind-ip` for custom IP binding\n - URL for 404 page now return status 404\n\n- **v0.1.4**:\n\n - Add `-no-cache` option to disable content caching\n - Add `-cors` option to write cross-origin resource sharing headers to the response\n - Record the X-Real-Ip field in the request header to the log\n - Fix bug of file not being closed after opening\n - Use HTML template for directory listing (thanks to @toby)\n\n- **v0.1.3**:\n\n - Add trailing slash if the request path is a directory and the directory contains a index file.\n - Add basic auth; add -am, -auth-method option.\n - Add -sa, -serve-all option to set if skip paths that start with dot.\n - Print the listening URLs after the server starts.\n\n- **v0.1.2**: Add TLS encryption; add custom 401 file.\n- **v0.1.1**: Fix bugs and typos.\n- **v0.1**: Initial release.\n\n## ToDo\n\nThe following functionalities will be added in the future:\n\n- Load config from file\n- IP filter\n- Custom log format\n- etc\n\n## What's the meaning of Ran\n\nIt's a Chinese PinYin and pronounce 燃, means flame burning.\n\n## Author\n\nmengqi \n\nIf you like this project, please give me a star.\n\n","has_starred","hub_user","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":21,"_84":11,"_85":11},"read","write","admin","user","storage_size",22117002,"orgData","recentTags",[92,130],{"_93":44,"_94":95,"_96":97,"_98":99,"_100":101,"_50":119,"_120":95,"_121":33,"_122":56,"_57":123,"_124":125,"_126":110,"_127":119,"_128":66,"_129":21},"content_type","creator",9164441,"full_size",8324451,"id",84731155,"images",[102],{"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":97,"_63":66,"_118":-5},"architecture","amd64","digest","sha256:ef4f138dfc394f43057a20268a910fb99c9121819c37df60ba102a12283ddf1e","features","","last_pulled","2026-10-05T11:49:24.939410231Z","last_pushed","2020-06-27T04:22:54Z","os","linux","os_features","os_version","size","variant","2020-06-27T07:54:07.615051Z","last_updater","last_updater_username","media_type","latest","repository",8404549,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_93":44,"_94":95,"_96":131,"_98":132,"_100":133,"_50":138,"_120":95,"_121":33,"_122":56,"_57":139,"_124":125,"_126":136,"_127":138,"_128":66,"_129":21},8324450,106542683,[134],{"_103":104,"_105":135,"_107":108,"_109":136,"_111":137,"_113":114,"_115":108,"_116":-5,"_117":131,"_63":66,"_118":-5},"sha256:4f071de3b1c7f8e259488c578c672da51de8ad4ca332521cf794802bd9a8f34f","2026-10-05T21:19:47.335269201Z","2020-06-27T04:25:59Z","2020-06-27T04:25:58.781775Z","v0.1.5","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":153,"_160":161,"_147":174,"_175":11},{"_40":154,"_42":155,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":156,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":69,"_70":71,"_72":11,"_73":33,"_74":157,"_80":11,"_81":159,"_86":33,"_87":88},[],[44],[56],{"_76":11,"_77":158},[79],{"_83":21,"_84":11,"_85":11},"tags",{"_162":163,"_164":-5,"_165":-5,"_166":167},"count",2,"next","previous","results",[168,171],{"_93":44,"_94":95,"_96":97,"_98":99,"_100":169,"_50":119,"_120":95,"_121":33,"_122":56,"_57":123,"_124":125,"_126":110,"_127":119,"_128":66,"_129":21},[170],{"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":97,"_63":66,"_118":-5},{"_93":44,"_94":95,"_96":131,"_98":132,"_100":172,"_50":138,"_120":95,"_121":33,"_122":56,"_57":139,"_124":125,"_126":136,"_127":138,"_128":66,"_129":21},[173],{"_103":104,"_105":135,"_107":108,"_109":136,"_111":137,"_113":114,"_115":108,"_116":-5,"_117":131,"_63":66,"_118":-5},[],"canDeleteTags","actionData","errors"]

m3ng9i/ran

Tags for m3ng9i/ran