Git Product home page Git Product logo

pimba's Introduction

Pimba!

Pimba is a small and simple CLI tool to easily publish and serve static files.

Build Status

Install

Binary releases are available. Please, download the suitable binary for your system.

If you have Go installed, you may also build and install it using go get:

$ go get [-u] github.com/signavio/pimba

Serving

pimba api

To serve the Pimba API and the static files, execute:

$ pimba api --storage /path/to/data/storage --secret my-jwt-secret

The flag --secret is mandatory and it's the necessary key for signing tokens for pushing to the Pimba buckets.

It's also possible to set the port, passing the flag --port <port-number>.

For further help, execute pimba help api.

Pushing

pimba push

To push files to the Pimba server, first enter the directory that you would like to publish and execute:

$ cd /path/to/publish
$ pimba push --server pimba.server.host:port --name my-bucket-name

If the flag --name is not passed, Pimba will create a bucket with a random string as the name.

After you did the first push to your bucket, use the returned token to be able to update the bucket. Execute:

$ pimba push --server pimba.server.host:port --name my-bucket-name --token returned-token

Remember to save your token in a safe place, Pimba doesn't store tokens, thus meaning that if you lose the token the bucket will become inaccessible.

For further help on how to push, execute pimba help push.

Configuration

It's also possible to have a configuration file for Pimba. Refer to pimba.yaml.sample and create a config file .pimba.yaml in your home directory. The configuration file will set defaults based on your preferences.

$ cp pimba.yaml.sample $HOME/.pimba.yaml
$ vim $HOME/.pimba.yaml #edit as you like

Maintainers

Stephano Zanzin - @microwaves

Thanks to @jbreckel and @m1schka for the very lean docker image. ๐Ÿฆ„

License

Pimba is released under the MIT license. See LICENSE.

pimba's People

Contributors

m1schka avatar microwaves avatar par-vathy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

pimba's Issues

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.