With Go’s webserver where does the root of the website map onto the filesystem?

by

Introduction

In Go the net/http package is used to provide Web Server functionality. This is not a static fileserver, it is much more than that.

There is no filesystem “root” concept. The provided web server uses handlers to serve HTTP requests which are mapped to URLs. A handler is responsible to process an HTTP request and to setup and generate the response. A handler can be registered e.g. with the Handle() or HandleFunc() functions. The server can be started with the ListenAndServe() function.

Read the package documentation of net/http to understand the basic concepts and to get started. It also contains many small examples.

The Blog article Writing Web Applications is also helpful.

Static File Server

However, a static file server or “filesystem” functionality is provided, there is a FileServer() function in the http package which returns a Handler which serves static files. You can specify the “root” folder to serve static files from as a parameter of FileServer().

If you pass an absolute path to FileServer(), then there is no question what that means. If you provide a relative path, it is always interpreted in the context of the current or working directory. By default this is the folder you start the application from (the folder you’re in when executing the go run ... command or the compiled executable binary).

Example:

http.Handle("https://stackoverflow.com/", http.FileServer(http.Dir("/tmp")))

This will setup a handler to serve files from the folder /tmp mapped to the root URL /. For example the response to the GET request "/mydoc.txt" will be the "/tmp/mydoc.txt" static file.

Complete application:

package main
import (
    "log"
    "net/http"
)
func main() {
    // Simple static webserver:
    http.Handle("https://stackoverflow.com/", http.FileServer(http.Dir("/tmp")))
    log.Fatal(http.ListenAndServe(":8080", nil))
}

You can do more complex mapping using the StripPrefix() function. Example:

// To serve a directory on disk (/tmp) under an alternate URL
// path (/tmpfiles/), use StripPrefix to modify the request
// URL's path before the FileServer sees it:
http.Handle("/tmpfiles/",
    http.StripPrefix("/tmpfiles/", http.FileServer(http.Dir("/tmp"))))

More Related Contents:

  1. Create a generic channel
  2. How to pipe several commands in Go?
  3. How to use a module that is outside of “GOPATH” in another module?
  4. slice of struct != slice of interface it implements?
  5. How can I convert string to integer in golang
  6. How to dump goroutine stacktraces?
  7. Does Go compiler’s evaluation differ for constant expression and other expression
  8. Cyclic dependencies and interfaces
  9. Accessing struct fields inside a map value (without copying)
  10. Why do I get a “cannot assign” error when setting value to a struct as a value in a map? [duplicate]
  11. Can I concurrently write different slice elements
  12. Organize local code in packages using Go modules
  13. How to compare if two structs, slices or maps are equal?
  14. Golang defer behavior
  15. Stack vs heap allocation of structs in Go, and how they relate to garbage collection
  16. Is unnamed arguments a thing in Go?
  17. How to fix parsing go.mod module declares its path as “x” but was required as “y”
  18. What is the meaning of “dot parenthesis” syntax? [duplicate]
  19. What is the idiomatic Go equivalent of C’s ternary operator?
  20. Can I construct a slice of a generic type with different type parameters?
  21. How to import local packages in go?
  22. How to implement generic interfaces?
  23. How to compare Go errors
  24. How do you get the output of a system command in Go?
  25. How do you statically link a c library in go using cgo?
  26. Capture or assign golang template output to variable
  27. How to start a Go program as a daemon in Ubuntu?
  28. Call a Struct and its Method by name in Go?
  29. Big O of append in Golang
  30. What do “value semantics’” and “pointer semantics” mean in Go?

Leave a Comment