Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adds asdf-calendarsync plugin documentation as a new installati… #121

Merged
merged 2 commits into from
Jan 31, 2024
Merged

docs: adds asdf-calendarsync plugin documentation as a new installati… #121

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76b1d3b
docs: adds asdf-calendarsync plugin documentation as a new installati…
FeryET Jan 25, 2024
0d5d031
refactor: adds notice about 'asdf-calendarsync' not being managed by …
FeryET Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,30 @@ data to a third party.

# How to use

Download the newest [release](https://github.com/inovex/CalendarSync/releases)
for your platform or install from [the AUR](https://aur.archlinux.org/packages/calendarsync-bin), create a modified `sync.yaml` file based on the content of the `./example.sync.yaml` file. Finally, start the app using `CALENDARSYNC_ENCRYPTION_KEY=<YourSecretPassword> ./calendarsync --config sync.yaml` and follow the instructions in the output.
## Installation

The app will create a file in the execution folder called `auth-storage.yaml`. In
this file the OAuth2 Credentials will be saved encrypted by your
`$CALENDARSYNC_ENCRYPTION_KEY`.
Download the newest [release](https://github.com/inovex/CalendarSync/releases) for your platform or install from [the AUR](https://aur.archlinux.org/packages/calendarsync-bin).

**Using [asdf-vm](https://github.com/asdf-vm/asdf)**

You can also install this program using `asdf-vm`.

```sh
asdf plugin add calendarsync
# or
asdf plugin add calendarsync https://github.com/FeryET/asdf-calendarsync.git
## finally
asdf install calendarsync
```
Note: The `asdf` plugin is not managed by inovex, but is provided by a CalendarSync user. inovex assumes no responsibility for proper provisioning.

## First Time Execution

Create a modified `sync.yaml` file based on the content of the `./example.sync.yaml` file. Finally, start the app using `CALENDARSYNC_ENCRYPTION_KEY=<YourSecretPassword> ./calendarsync --config sync.yaml` and follow the instructions in the output.

The app will create a file in the execution folder called `auth-storage.yaml`. In this file the OAuth2 Credentials will be saved encrypted by your `$CALENDARSYNC_ENCRYPTION_KEY`.

----

# Configuration

Expand Down