# salt.fileserver.hgfs

The backed for the mercurial based file server system.

After enabling this backend, branches, bookmarks, and tags in a remote mercurial repository are exposed to salt as different environments. This feature is managed by the fileserver_backend option in the salt master config.

This fileserver has an additional option `hgfs_branch_method` that will set the desired branch method. Possible values are: `branches`, `bookmarks`, or `mixed`. If using `branches` or `mixed`, the `default` branch will be mapped to `base`.

depends: | mercurial

`salt.fileserver.hgfs.` `dir_list`(load)

  Return a list of all directories on the master

`salt.fileserver.hgfs.` `envs`()

  Return a list of refs that can be used as environments

`salt.fileserver.hgfs.` `file_hash`(load, fnd)

  Return a file hash, the hash type is set in the master config file

`salt.fileserver.hgfs.` `file_list`(load)

  Return a list of all files on the file server in a specified environment

`salt.fileserver.hgfs.` `file_list_emptydirs`(load)

  Return a list of all empty directories on the master

`salt.fileserver.hgfs.` `find_file`(path, short='base', **kwargs)

  Find the first file to match the path and ref, read the file out of hg and send the path to the newly cached file

`salt.fileserver.hgfs.` `init`()

  Return the hg repo object for this session

`salt.fileserver.hgfs.` `purge_cache`()

`salt.fileserver.hgfs.` `serve_file`(load, fnd)

  Return a chunk from a file based on the data received

`salt.fileserver.hgfs.` `update`()

  Execute a hg pull on all of the repos

Current Salt release: 0.17.1

#### Previous topic

salt.fileserver.gitfs

#### Next topic

salt.fileserver.roots

### Quick search

Enter search terms or a module, class or function name.

### Upcoming SaltStack Events

My conferences on Lanyrd