Skip to content

Commit

Permalink
Major README update
Browse files Browse the repository at this point in the history
  • Loading branch information
@pascalandy
pascalandy committed Sep 10, 2019
1 parent 57abf22 commit 7d6e07b
Showing 1 changed file with 93 additions and 80 deletions.
173 changes: 93 additions & 80 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,62 +1,68 @@
# [resilio-in-docker](https://github.com/firepress-org/resilio-in-docker)

A slim docker image for **Resilio Sync** using best practices available.

**It features**:

- A CI build made **every day** and on every commits
- A **multi-stage** build
- Image **tests** using docker-official tests
- A vulnerability checker using the **Aqua scanner**
- An easy to read **logs** within the CI history
- The push of **four tags** to registry
- The compression of the app (**UPX**)
- Detailed **Labels**
- The **Alpine** image in the final image
- A small foot print of about **31MB** (uncompressed) as this app relies on **glibc**

## About Resilio Sync

[Resilio Sync](https://www.resilio.com/connect/) is a fast, reliable, and simple file sync and share solution, powered by a P2P technology.
 

![loading](https://user-images.githubusercontent.com/6694151/64082499-f4e50800-ccdd-11e9-827c-66dfb380a321.gif)
<p align="center">
Brought to you by
</p>

<br>
<p align="center">
<a href="https://firepress.org/">
<img src="https://user-images.githubusercontent.com/6694151/50166045-2cc53000-02b4-11e9-8f7f-5332089ec331.jpg" width="340px" alt="FirePress" />
</a>
</p>

## Regarding Github Actions & CI configuration
<p align="center">
<a href="https://firepress.org/">FirePress.org</a> |
<a href="https://play-with-ghost.com/">play-with-ghost</a> |
<a href="https://github.com/firepress-org/">GitHub</a> |
<a href="https://twitter.com/askpascalandy">Twitter</a>
<br /> <br />
</p>

[See README-CI.md](./README-CI.md)
&nbsp;

<br>
# [resilio-in-docker](https://github.com/firepress-org/resilio-in-docker)

## Docker hub
## What is this?

Always check on docker hub the most recent build:<br>
[https://hub.docker.com/r/devmtl/resilio/tags](https://hub.docker.com/r/devmtl/resilio/tags)
A slim docker image for **Resilio Sync** using best practices available.

You should use **this tag format** `$VERSION_$DATE_$HASH-COMMIT` in production.
## Features

- an **everyday build** and on every commit (CI)
- a build from the **sources** (CI)
- a logic of **four docker tags** on the master branch (CI) and logic of **three docker tags** on any other branches (CI)
- few UAT **tests** (CI)
- an automatic push of the **README** to Dockerhub (CI)
- **Slack** notifications when a build succeed (Job 2) (CI)
- a **multi-stage** build (Dockerfile)
- an **alpine** base docker image (Dockerfile)
- **Labels** (Dockerfile)
- this app is compressed using **UPX** (Dockerfile)
- a **small footprint** docker image's size (Dockerfile)
- `utility.sh` based on [bash-script-template](https://github.com/firepress-org/bash-script-template)
- and probably more, but hey, who is counting?

**To add in the future**:
- a **non-root** user (Dockerfile)
- having this app running as PID 1 under **tiny** (Dockerfile)

```
devmtl/resilio:2.6.3_2019-09-01_16H28s32_399d1a6
```
## About Resilio Sync

These tags are also available to test stuff quickly:
[Resilio Sync](https://www.resilio.com/connect/) is a fast, reliable, and simple file sync and share solution, powered by a P2P technology.

```
devmtl/resilio:2.6.3
devmtl/resilio:stable
devmtl/resilio:latest
```
![loading](https://user-images.githubusercontent.com/6694151/64082499-f4e50800-ccdd-11e9-827c-66dfb380a321.gif)

<br>
## How to use it, Docker hub

<details><summary>Expand content (click here).</summary>
<p>

# How to use it
## How to use it

```
LOCAL_STORAGE="/Volumes/960G/_pascalandy/tmp2/resilio/data"
LOCAL_STORAGE="~/resilio/data"
CTN_NAME="resilio"
IMG_resilio="devmtl/resilio:2.6.3_2019-09-01_16H28s32_399d1a6"
IMG_resilio="devmtl/resilio:2.6.3_2019-09-10_18H15s21_0383a37"
```

### Simple run
Expand Down Expand Up @@ -142,41 +148,59 @@ docker service create \
${IMG_resilio}
```

<br>
## CI configuration & Github Actions

&nbsp;
[See README-CI.md](./README-CI.md)

<p align="center">
Brought to you by
</p>
## Docker hub

<p align="center">
<a href="https://firepress.org/">
<img src="https://user-images.githubusercontent.com/6694151/50166045-2cc53000-02b4-11e9-8f7f-5332089ec331.jpg" width="340px" alt="FirePress" />
</a>
</p>
Always check on docker hub the most recent build:<br>
https://hub.docker.com/r/devmtl/noti/tags

You should use **this tag format** in production.<br>
`${VERSION} _ ${DATE} _ ${HASH-COMMIT}`

```
devmtl/resilio:2.6.3_2019-09-10_18H15s21_0383a37
```

These tags are also available to try stuff quickly:

```
devmtl/resilio:2.6.3
devmtl/resilio:stable
devmtl/resilio:latest
```

## Related docker images

[See README-related.md](./README-related.md)

<p align="center">
<a href="https://firepress.org/">FirePress.org</a> |
<a href="https://play-with-ghost.com/">play-with-ghost</a> |
<a href="https://github.com/firepress-org/">GitHub</a> |
<a href="https://twitter.com/askpascalandy">Twitter</a>
<br /> <br />
</p>
</details>

&nbsp;

<br>
## Website hosting

If you are looking for an alternative to WordPress, [Ghost](https://firepress.org/en/faq/#what-is-ghost) might be the CMS you are looking for. Check out our [hosting plans](https://firepress.org/en).

## Hosting
![ghost-v2-review](https://user-images.githubusercontent.com/6694151/64218253-f144b300-ce8e-11e9-8d75-312a2b6a3160.gif)

At FirePress we empower entrepreneurs and small organizations to create their websites on top of [Ghost](https://firepress.org/en/faq/#what-is-ghost).

At the moment, our **pricing** for hosting one Ghost website is $15 (Canadian dollars). This price will be only available for our first 100 new clients, starting May 1st, 2019 🙌. [See our pricing section](https://firepress.org/en/pricing/) for details.
## Why, Contributing, License

More details [about this annoucement](https://forum.ghost.org/t/host-your-ghost-website-on-firepress/7092/1) on Ghost's forum.
<details><summary>Expand content (click here).</summary>
<p>

## Why all this work?

Our [mission](https://firepress.org/en/our-mission/) is to empower freelancers and small organizations to build an outstanding mobile-first website.

Because we believe your website should speak up in your name, we consider our mission completed once your site has become your impresario.

<br>
Find me on Twitter [@askpascalandy](https://twitter.com/askpascalandy).

— [The FirePress Team](https://firepress.org/) 🔥📰

## Contributing

Expand All @@ -188,22 +212,11 @@ The power of communities pull request and forks means that `1 + 1 = 3`. You can
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request

Check this post for more details: [Contributing to our Github project](https://pascalandy.com/blog/contributing-to-our-github-project/). Also, by contributing you agree to the [Contributor Code of Conduct on GitHub](https://pascalandy.com/blog/contributor-code-of-conduct-on-github/). It's plain common sense really.

<br>
Check this post for more details: [Contributing to our Github project](https://pascalandy.com/blog/contributing-to-our-github-project/). Also, by contributing you agree to the [Contributor Code of Conduct on GitHub](https://pascalandy.com/blog/contributor-code-of-conduct-on-github/).

## License

- This git repo is under the **GNU V3** license. [Find it here](https://github.com/pascalandy/GNU-GENERAL-PUBLIC-LICENSE/blob/master/LICENSE.md).

<br>
- This git repo is under the **GNU V3** license. [Find it here](./LICENSE).

## Why all this work?

Our [mission](https://firepress.org/en/our-mission/) is to empower freelancers and small organizations to build an outstanding mobile-first website.

Because we believe your website should speak up in your name, we consider our mission completed once your site has become your impresario.

For more info about the man behind the startup, check out my [now page](https://pascalandy.com/blog/now/). You can also follow me on Twitter [@askpascalandy](https://twitter.com/askpascalandy).

— The FirePress Team 🔥📰
</p>
</details>

0 comments on commit 7d6e07b

Please sign in to comment.