github.com/filecoin-project/bacalhau@v0.3.23-0.20230228154132-45c989550ace/README.md (about) 1 <!-- commenting out until we can fix the image logo [](https://dl.circleci.com/status-badge/redirect/null/filecoin-project/bacalhau/tree/main) 2 --> 3 4 <!-- commenting out until we can fix the image logo [](https://dl.circleci.com/status-badge/redirect/null/filecoin-project/bacalhau/tree/main) 5 --> 6 7 <!-- commenting out until we can fix the image logo [](https://dl.circleci.com/status-badge/redirect/null/filecoin-project/bacalhau/tree/main) 8 --> 9 <p align="center"> 10 <a href="https://github.com/filecoin-project/bacalhau"> 11 <img src="https://github.com/filecoin-project/bacalhau/blob/590a1c84dbde3636a54c371c40c73ed6ea86bf48/docs/images/Bacalhau-horizontal.png" alt="Bacalhau logo" width="300"/> 12 13 </a> 14 </p> 15 16 <h1 align="center">The Filecoin Distributed Computation Frameworkโก๏ธ <br>Compute Over Data(CoD)</h1> 17 <br> 18 19 <p align="center"> 20 <a href="https://github.com/filecoin-project/bacalhau/blob/dev/LICENSE" alt="Contributors"> 21 <img src="https://img.shields.io/badge/license-Apache-green" /> 22 </a> 23 <a href="https://github.com/filecoin-project/bacalhau/releases/" alt="Release"> 24 <img src="https://img.shields.io/github/v/release/filecoin-project/bacalhau?display_name=tag" /> 25 </a> 26 <a href="https://github.com/filecoin-project/bacalhau/pulse" alt="Activity"> 27 <img src="https://img.shields.io/github/commit-activity/m/filecoin-project/bacalhau" /> 28 </a> 29 <a href="https://img.shields.io/github/downloads/filecoin-project/bacalhau/total"> 30 <img src="https://img.shields.io/github/downloads/filecoin-project/bacalhau/total" alt="total download"> 31 </a> 32 <a href="https://github.com/filecoin-project/bacalhau/graphs/contributors"> 33 <img src="https://img.shields.io/github/contributors/filecoin-project/bacalhau" alt="Bacalhau contributors" > 34 </a> 35 <a href="https://www.bacalhau.org/"> 36 <img alt="Bacalhau website" src="https://img.shields.io/badge/website-bacalhau.org-red"> 37 </a> 38 <a href="https://filecoinproject.slack.com/" alt="Slack"> 39 <img src="https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack" /> 40 </a> 41 <a href="https://twitter.com/intent/follow?screen_name=BacalhauProject"> 42 <img src="https://img.shields.io/twitter/follow/BacalhauProject?style=social&logo=twitter" alt="follow on Twitter"> 43 </a> 44 </p> 45 46 [Bacalhau](https://www.bacalhau.org/) is a platform for fast, cost efficient, and secure computation by running jobs where the data is generated and stored. With Bacalhau you can streamline your exisiting workflows without the need of extensive rewriting by running arbitrary Docker containers and WebAssembly (wasm) images as tasks. 47 48 ## Table of Contents 49 - [Why Bacalhau](#why-bacalhau) 50 - [Getting started](#getting-started---bacalhau-in-1-minute) 51 - [Learn more](#learn-more) 52 - [Documentation](#documentation) 53 - [Developers guide](#developers-guide) 54 - [Running Bacalhau locally](#running-bacalhau-locally) 55 - [Notes for Dev contributors](#notes-for-dev-contributors) 56 - [Ways to contribute ](#ways-to-contribute) 57 - [Current state of Bacalhau](current-state-of-bacalhau) 58 - [License](#license) 59 60 ## Why Bacalhau? 61 - :zap: **Fast job processing**: Jobs in Bacalhau are processed where the data was created and all jobs are parallel by default. 62 - :moneybag: **Low cost**: Reduce (or eliminate) ingress/egress costs since jobs are processed closer to the source. Take advantage of as well idle computation capabilities at the edge. 63 - :lock: **Secure**: Data scrubbing and security can before migration to reduce the chance of leaking private information, and with a far more granular, code-based permission model. 64 - ๐ **Large-scale data**: Bacalhau operates on a network of open compute resources made available to serve any data processing workload. With Bacalhau, you can batch process petabytes (quadrillion bytes) of data. 65 66 ## Getting started - Bacalhau in 1 minute 67 68 Go to the folder directory that you want to store your job results 69 70 Install the bacalhau client 71 72 ```bash 73 curl -sL https://get.bacalhau.org/install.sh | bash 74 ``` 75 76 Submit a "Hello World" job 77 78 ```bash 79 bacalhau docker run ubuntu echo Hello World 80 ``` 81 82 Download your result 83 84 ```bash 85 bacalhau get 63d08ff0..... # make sure to use the right job id from the docker run command 86 ``` 87 88  89 90 For a more detailed tutorial, check out our [Getting Started tutorial](https://docs.bacalhau.org/getting-started/installation). 91 92 ### Learn more 93 - Understand [Bacalhau Concepts](https://youtu.be/WnTlwXHhbcI) 94 - Get an overview of the [different usecases](https://www.youtube.com/watch?v=gAHaMsTknZM) that you can use with Bacalhau. 95 - To see Bacalhau in action, check out the [Bacalhau Examples](https://docs.bacalhau.org/examples/) 96 - You can check out this featured example video tutorial [Text to image- Stable Diffusion GPU](https://www.youtube.com/playlist?list=PL_1oLZF_wrbTIZdRWqFbtOeI78SdDdsEz). You can watch more tutorials [here](https://www.youtube.com/playlist?list=PL_1oLZF_wrbTIZdRWqFbtOeI78SdDdsEz) 97 98 ## Documentation 99 ๐ [Read the Bacalhau docs guide here](https://docs.bacalhau.org/)! ๐ 100 101 The Bacalhau docs is the best starting point as it contains all the information to ensure that everyone who uses Bacalhau is doing so efficiently. 102 103 ## Developers guide 104 105 ### Running Bacalhau locally 106 107 Developers can spin up bacalhau and run a local demo using the `devstack` command. 108 109 Please see [docs/running_locally.md](docs/running_locally.md) for instructions. Also, see [docs/debugging_locally.md](docs/debugging_locally.md) for some useful tricks for debugging. 110 111 ### Notes for Dev contributors 112 113 Bacalhau's CI pipeline performs a variety of linting and formatting checks on new pull requests. 114 To have these checks run locally when you make a new commit, you can use the precommit hook in `./githooks`: 115 116 ```bash 117 make install-pre-commit 118 119 # check if pre-commit works 120 make precommit 121 ``` 122 If you want to run the linter manually: 123 124 ```bash 125 curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sudo sh -s -- -b /usr/local/go/bin 126 golangci-lint --version 127 make lint 128 ``` 129 The config lives in `.golangci.yml` 130 131 ## Issues, feature requests, and questions 132 133 We are excited to hear your feedback! 134 * For issues and feature requests, please [open a GitHub issue](https://github.com/filecoin-project/bacalhau/issues). 135 * For questions, give feedback or answer questions that will help other user product please use [GitHub Discussions](https://github.com/filecoin-project/bacalhau/discussions). 136 * To engage with other members in the community, join us in our [slack community](https://filecoin.io/slack/) `#bacalhau` channel :raising_hand: 137 138 ## Ways to contribute 139 **All manner of contributions are more than welcome!** 140 141 We have highlighted the different ways you can contribute in our [contributing guide](https://docs.bacalhau.org/community/ways-to-contribute). You can be part of community discussions, development, and more. 142 143 ## Current state of Bacalhau ๐ 144 Building never stops ๐ ๏ธ. **Bacalhau is a work in progress!**. Learn more about our future plans in this [roadmap document](https://www.starmaps.app/roadmap/github.com/filecoin-project/bacalhau/issues/1151) 145 146 ## License 147 148 [Apache-2.0](./LICENSE)