Giter Club home page Giter Club logo

mount-smbfs's Introduction

mount-smbfs

Mount Samba shares via Finder on OSX

  • Uses Finder to handle authentication dialogs
  • Fires a callback once connected / authenticated
  • Use the Volume path with fs to perform file/folder ops like you normally would
  • Useful for creating desktop apps within internal environments that use file shares

Usage

var smbfs = require('mount-smbfs');

smbfs.mount('MACHINE/ShareName', function(err, mountPath) {
	console.log(mountPath); // -> /Volumes/ShareName
});

Documentation

mount(sharepath, callback)

Mounts the specified share path to a Volume, and displays Finder's authentication if credentials are necessary.

  • sharepath: The full share path to connect to, e.g. MACHINE/SharedFolder
  • callback(err, mountpath): Where mountpath is the resulting volume path string: /Volumes/SharedFolder

umount([mountpath], callback)

Unmounts the specified path, or defaults to the currently mounted share if mountpath isn't provided.

  • mountpath: The volume path you want to unmount: /Volumes/SharedFolder
  • callback(err)

getPath()

Returns the volume path string, e.g. /Volumes/SharedFolder

Example: mount a share & get a list of files

var smbfs = require('mount-smbfs');
var fs = require('fs');

smbfs.mount('MACHINE/ShareName', function(err, mountPath) {
	fs.readdir(mountPath, function(err, files) {
		console.log(files);
	});
});

Contributors

Please feel free to post any issues you find, hack around, present suggestions, etc.!

License

The MIT License (MIT)

Copyright (c) 2015 Andy Merskin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

mount-smbfs's People

Contributors

andymerskin avatar

Stargazers

Roman avatar

Watchers

Will Justice avatar

Forkers

stursby

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.