beuterei / restic-rest-server

Docker setup for restic-rest-server

restic-rest-server

Docker setup for restic-rest-server

· Report Bug · Request Feature

About The Project

Small docker setup for restic-rest-server. The production environment also uses jwilder/nginx-proxy and nginx-proxy/docker-letsencrypt-nginx-proxy-companion.

Getting Started Develop

To get a local copy up and running follow these simple steps.

Prerequisites

• Docker
• Docker Compose

Installation

1. Clone the repo

git clone https://github.com/beuluis/restic-rest-server.git

2. Start docker-compose

docker-compose up --build

Customization

1. Create a .env file

touch .env

2. Overwrite variables as you like (format: {variable name}={variable value})

Variable	Description	Default value	Required
RESTIC_REST_SERVER_FLAGS	Flags see Restic Rest Server Docs	--private-repos	false
PORT	Which port is mapped to your host machine	8001	false

Getting Started Production

To get a copy up and running follow these simple steps.

Prerequisites

• Docker
• Docker Compose
• Nginx by me

Installation

1. Clone the repo

git clone https://github.com/beuluis/restic-rest-server.git --branch master

2. Generate a htpasswd string e.g. on htpasswd generator. Use SHA-1 as algorithm
3. Create a .htpasswdfile and fill it with your string

echo "<your string>" > .htpasswd

2. Create a .env.prod file

touch .env.prod

3. Overwrite all variables marked under Customization as required
4. Start docker-compose

docker-compose --env-file ./.env.prod -f docker-compose.yml -f docker-compose.production.yml up -d

Customization

1. Create a .env.prod file

touch .env.prod

2. Overwrite variables as you like (format: {variable name}={variable value})

Variable	Description	Default value	Required
PROXY_NETWORK_NAME	Proxy network name	nginxproxynet	false
RESTIC_REST_SERVER_FLAGS	Flags see Restic Rest Server Docs	--private-repos	false
HOST	Host which your container should be accessible. E.g. test.com	none	true

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Luis Beu - [email protected]