micro-sip-nextcloud-bridge

A Bridge between MicroSip and Nextcloud.

Table of Contents

1. :pushpin: Overview
2. :star: Features
3. :rocket: Quick Start
4. :gear: System Requirements
5. :pick: Contributing
6. :page_facing_up: License

:pushpin: Overview

The micro-sip-nextcloud-bridge is a tool designed to seamlessly integrate MicroSIP with Nextcloud. The bridge allows you to synchronize contacts.

:star: Features

• Sync contacts to MicroSIP from Nextcloud.
• Easy-to-use configuration for instant setup.

:rocket: Quick Start

First you have to set the environment variables see config.env Then choose the option that suits you best.

• Use pip:

  pip install micro-sip-nextcloud-bridge
  # then call
  micro-sip-nextcloud-bridge # or python -m micro_sip_nextcloud_bridge

• Use Docker:

  docker run -p 8123:8123 --env-file=config.env lolexplain/micro-sip-nextcloud-bridge

• Use source code with pip:

  git clone https://github.com/JuliusKoenig/micro-sip-nextcloud-bridge.git
  pip install -e .
  # then call
  micro-sip-nextcloud-bridge # or python -m micro_sip_nextcloud_bridge

• Use source code with Docker:

  git clone https://github.com/JuliusKoenig/micro-sip-nextcloud-bridge.git
  docker build . -t micro-sip-nextcloud-bridge
  docker run -p 8123:8123 --env-file=config.env micro-sip-nextcloud-bridge

Once the micro-sip-nextcloud-bridge has been successfully started, only the user directory needs to be stored.

:gear: System Requirements

• Python: Version 3.12 or later
• Dependencies: See the pyproject.toml file
• Operating System: Cross-platform (Windows, macOS, Linux)

:pick: Contributing

We welcome contributions! To contribute:

1. Fork this repository.
2. Create a new branch for your feature or bug fix:

   git checkout -b feature/my-feature

1. Commit your changes and push them to your fork:

   git commit -m "Add new feature"
   git push origin feature/my-feature

1. Open a pull request and provide a description of your changes.

:page_facing_up: License

This project is licensed under the GPL-3.0 License. See the LICENSE file for details.