Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ipfs/infra
Tools and systems for the IPFS community
https://github.com/ipfs/infra
Last synced: 3 months ago
JSON representation
Tools and systems for the IPFS community
- Host: GitHub
- URL: https://github.com/ipfs/infra
- Owner: ipfs
- License: mit
- Archived: true
- Created: 2015-03-17T01:03:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-23T22:01:52.000Z (about 3 years ago)
- Last Synced: 2024-05-02T08:58:10.858Z (7 months ago)
- Language: Shell
- Homepage:
- Size: 1.67 MB
- Stars: 132
- Watchers: 25
- Forks: 45
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - ipfs/infra - Tools and systems for the IPFS community (others)
README
# IPFS Infrastructure
[](http://protocol.ai)
[](http://ipfs.io/)
[](http://webchat.freenode.net/?channels=%23ipfs)
[](https://github.com/RichardLitt/standard-readme)
> Tools for maintaining infrastructure for the IPFS community.
- Introduction
- Getting started
- Usage
- Known issues
- Common tasks
## Progress and Tracking
[](https://waffle.io/ipfs/infra/metrics/throughput)
## Introduction
This repository contains the technical infrastructure of the IPFS community.
- Public HTTP-to-IPFS Gateway: https://ipfs.io
- Default bootstrap used by IPFS: `ipfs bootstrap`
- Private networking between the hosts (cjdns with nginx access control)
- Monitoring of services and hosts: http://metrics.ipfs.team
- Pinbot, an IRC bot in chat.freenode.net/#ipfs-pinbot
Infrastructure that isn't contained here:
- Websites deployment: ipfs.io, dist.ipfs.io, blog.ipfs.io, chat.ipfs.io
- DNS settings for ipfs.io, ipld.io, multiformats.io, libp2p.io, orbit.chat, ipfs.team, protocol.ai
- TeamCity CI: http://ci.ipfs.team:8111
## Getting started
We use a tool called Provsn to maintain the setup of hosts and services.
The fundamental principle of Provsn is that hosts are in a certain state,
and units of code are run to transition into a different state.
Provsn is a plain shell script, and each unit consists of shell scripts too:
- The `env` script exposes variables and functions to the unit itself, and other units.
- The `build` script is run on the client and builds container images, config files, etc.
- The `install` script is run on the host and transitions it into the desired state.
**Note:** there are a few bits of Ansible code left over, which are to be migrated to Provsn.
You can find them in the `ansible/` directory.
To test whether you're all set up, execute a simple command on all hosts.
```sh
> ./provsn exec all 'whoami'
pluto: root
uranus: root
[...]
```
Two environment variables can be used to alter Provsn's operation:
- `PROVSN_JOBS` -- this controls the number of hosts to run on in parallel, and defaults to 4.
- `PROVSN_TRACE` -- if set, this enables Bash tracing (`set -x`) for extensive debugging information.
Note that this *will contain sensitive information and secrets*.
## Usage
### Known issues
- no verbose option, need to comment out dev-null-redirections in unit scripts
- if container that's supposed to be restarted is in a restart loop, we don't notice it's kinda running, and try to start it, and that fails because the name is already in use
### Common tasks
- gathering ipfs debug info
- updating ipfs
- deploying a website
- adding a root user
- adding hashes to the blocklist
### How can I get ssh access to the instances?
Add you ssh-key to the list of keys available in `base/env.sh`, like this: https://github.com/ipfs/infrastructure/blob/master/base/env.sh#L9 and then submit a PR with the changes.
### Other community infrastructure:
More info in https://github.com/ipfs/community
- Github
- https://github.com/ipfs
- https://github.com/libp2p
- https://github.com/ipld
- https://github.com/multiformats
- https://github.com/protocol
- https://github.com/ipfsbot
- Communication
- IRC: chat.freenode.net/#ipfs and https://chat.ipfs.io
- ipfs-users group: https://groups.google.com/forum/#!forum/ipfs-users
- Slack
- https://twitter.com/ipfsbot
- CI / Testing
- GitCop
- TeamCity: http://ci.ipfs.team:8111
- Travis CI
- Circle CI
## Contribute
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/infrastructure/issues)!
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
### Want to hack on IPFS?
[](https://github.com/ipfs/community/blob/master/contributing.md)
## License
MIT