Skip to content

Commit

Permalink
Add redis example; update/add logos (#968)
Browse files Browse the repository at this point in the history
* Add redis example; update/add logos

* Smaller tech logos
  • Loading branch information
markphelps committed Jul 29, 2022
1 parent 550b5f5 commit 5ebcc6a
Show file tree
Hide file tree
Showing 14 changed files with 113 additions and 12 deletions.
37 changes: 25 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@ Flipt supports use cases such as:
- :white_check_mark: **Simplicity** - Flipt is a single binary with no external dependencies by default.
- :thumbsup: **Compatibility** - REST, GRPC, MySQL, Postgres, SQLite, Redis.. Flipt supports it all.

## Works With

<p align="center">
<img src="./logos/sqlite.svg" alt="SQLite" width=150 height=150 />
<img src="./logos/mysql.svg" alt="MySQL" width=150 height=150 />
<img src="./logos/postgresql.svg" alt="PostgreSQL" width=150 height=150 />
<img src="./logos/redis.svg" alt="Redis" width=150 height=150 />
<img src="./logos/prometheus.svg" alt="Prometheus" width=150 height=150 />
</p>

## Try It

Try the latest version of Flipt out for yourself.
Expand All @@ -99,6 +109,21 @@ Flipt UI will now be reachable at [http://127.0.0.1:8080/](http://127.0.0.1:8080

For more permanent methods of running Flipt, see the [Installation](https://flipt.io/docs/installation/) section.

## Logos

Some of our users running Flipt in production.

<p>
<a href="https://paradigm.co">
<img src="./logos/users/paradigm.png" alt="Paradigm" />
</a>
<a href="https://rokt.com">
<img src="logos/users/rokt.svg" alt="Rokt" width="200"/>
</a>
</p>

Using Flipt at your company? Open a PR and add your logo here!

## Integration

Checkout the [integration docs](https://flipt.io/docs/integration/) for more info on how to integrate Flipt into your existing application.
Expand Down Expand Up @@ -160,18 +185,6 @@ The server code is licensed under the [GPL 3.0 License](https://spdx.org/license

See [LICENSE](LICENSE).

## Logos

| [![Paradigm](logos/paradigm-logo-light-vertical-128x128.png)](https://www.paradigm.co/) |
| ------------------------------------------------------------------------------------------|
| [Paradigm](https://www.paradigm.co/) |

| <img src="logos/rokt.svg" width="200"/> |
| ------------------------------------------------------------------------------------------|
| [Rokt](https://www.rokt.com/) |

Using Flipt at your company? Open a PR and add your logo here!

## Sponsors

If you use Flipt at your company, please consider [becoming a sponsor](https://github.com/sponsors/markphelps) today.
Expand Down
4 changes: 4 additions & 0 deletions examples/mysql/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<p align="center">
<img src="../../logos/mysql.svg" alt="MySQL" width=250 height=250 />
</p>

# MySQL Example

This example shows how you can run Flipt with a MySQL database over the default SQLite.
Expand Down
4 changes: 4 additions & 0 deletions examples/postgres/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<p align="center">
<img src="../../logos/postgresql.svg" alt="Postgres" width=250 height=250 />
</p>

# Postgres Example

This example shows how you can run Flipt with a Postgres database over the default SQLite.
Expand Down
4 changes: 4 additions & 0 deletions examples/prometheus/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<p align="center">
<img src="../../logos/prometheus.svg" alt="Prometheus" width=250 height=250 />
</p>

# Prometheus Example

This example shows how you can run Flipt with a Prometheus sidecar application in Docker.
Expand Down
8 changes: 8 additions & 0 deletions examples/redis/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
FROM flipt/flipt:latest

USER root

RUN apk update && apk add --no-cache git bash

RUN git clone https://github.com/vishnubob/wait-for-it.git /tmp && \
chmod +x /tmp/wait-for-it.sh
36 changes: 36 additions & 0 deletions examples/redis/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<p align="center">
<img src="../../logos/redis.svg" alt="Redis" width=250 height=250 />
</p>

# Redis Example

This example shows how you can run Flipt with a Redis cache for caching flag and evaluation responses.

This works by setting the following environment variables to configure Redis in the container:

```bash
FLIPT_CACHE_ENABLED=true
FLIPT_CACHE_TTL=60s
FLIPT_CACHE_BACKEND=redis
FLIPT_CACHE_REDIS_HOST=redis
FLIPT_CACHE_REDIS_PORT=6379
```

For more information on how to use Redis with Flipt, see the [Flipt caching documentation](https://flipt.io/docs/configuration#caching).

## Requirements

To run this example application you'll need:

* [Docker](https://docs.docker.com/install/)
* [docker-compose](https://docs.docker.com/compose/install/)

## Running the Example

1. Run `docker-compose up` from this directory
1. Open the Flipt UI (default: [http://localhost:8080](http://localhost:8080))
1. Check the logs to see that the Redis cache is enabled:

```console
level=debug msg="cache: \"redis\" enabled" server=grpc
```
27 changes: 27 additions & 0 deletions examples/redis/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
version: "3"

services:
redis:
image: redis:latest
networks:
- flipt_network

flipt:
build: .
depends_on:
- redis
ports:
- "8080:8080"
networks:
- flipt_network
environment:
- FLIPT_CACHE_ENABLED=true
- FLIPT_CACHE_TTL=60s
- FLIPT_CACHE_BACKEND=redis
- FLIPT_CACHE_REDIS_HOST=redis
- FLIPT_CACHE_REDIS_PORT=6379
- FLIPT_LOG_LEVEL=debug
command: ["./tmp/wait-for-it.sh", "redis:6379", "--", "./flipt"]

networks:
flipt_network:
1 change: 1 addition & 0 deletions logos/mysql.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions logos/postgresql.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions logos/prometheus.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5ebcc6a

Please sign in to comment.