Docker image for tos

Simple docker images for TOS
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This repository contains 2 docker images that you can build on your own.

• Dockerfile contains the most basic docker image (archlinux image with tos repository)
• Dockerfile.user contains a full tos image together with a build in user (includes things such as yay)

Getting Started

Prerequisites

All you need is docker You can also use make to make your life a bit easier.

Installation

1. Clone the tos-docker

git clone https://github.com/ODEX-TOS/tos-docker.git

2. Install docker

pacman -Syu docker

3. Enable docker

systemctl start docker && systemctl enable docker

Usage

Use our image

docker pull f0xedb/tos:latest
docker pull f0xedb/tos-user:latest

Build your own image

Everything below will be explained using make and a Makefile if you wish to run the commands yourself look into the Makefile

Build the docker containers

# to build Dockerfile
make build
# to build Dockerfile.user
make build-user

build and upload image

# Dockerfile
make all-tos
# Dockerfile-user
make all-user

By default the docker images are called tos and tos-user And also upload by default go to f0xedb/tos:latest

Override variabled

If you wish to rename the image or upload to a different docker user do the following

DOCKER_USER="f0xedb" IMAGE_NAME="tos-base" IMAGE_NAME_USER="tos" make all

DOCKER_USER is an env variable that holds the user to upload the images to

IMAGE_NAME is an env variable that holds the image name for the Dockerfile

IMAGE_NAME_USER is the same as IMAGE_NAME but for Dockerfile.user

Cleanup the docker build files/images

make clean

Run the docker container locally

make run
make run-user

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be 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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

F0xedb - [email protected]

Project Link: https://github.com/ODEX-TOS/tos-docker

Acknowledgements

• ODEX-TOS