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

Jump to bottom

docs(readme): add sunset notice #296

Merged
merged 2 commits into from
Aug 23, 2024
Merged

docs(readme): add sunset notice #296

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97356c1
docs(readme): add sunset notice
meowgorithm Aug 23, 2024
879123a
docs(readme): update sunset notice
meowgorithm Aug 23, 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
36 changes: 34 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,37 @@
# Sunsetting Charm Cloud

To continue innovating in this space and supporting our larger projects, we need to keep our small team focused on the most impactful work. On **29 November 2024**, we will be sunsetting Charm Cloud. At that time we will be removing the servers from production and archiving the project on GitHub. Charm Cloud is self-hostable, so you can back up your data before that time and continue using this project on your own server.

The code will continue to be open source and publicly available. If you love this project and would like to maintain a fork, please do.

[Learn more](https://github.com/charmbracelet/charm/blob/main/docs/self-hosting.md) about self-hosting Charm Cloud.

## Impacted tools

To configure both [Skate](https://github.com/charmbracelet/skate) and [Glow](https://github.com/charmbracelet/glow) to work with your own server, you'll need to update the Charm Cloud client environment variables. Glow historically integrated into the Charm Cloud via a stashing feature, but as of [Skate v1.0.0][skatev1] and [Glow v2.0.0][glowv2] the Charm Cloud integration in both applications has been removed (Skate now operates on a local database: to migrate your data see the [Skate v1.0.0 Release Notes][skatev1]). For those using older versions, you can continue to use Charm Cloud features with your own server. Here are the relevant environment variables:

```go
// Config contains the Charm client configuration.
type Config struct {
Host string `env:"CHARM_HOST" envDefault:"cloud.charm.sh"`
SSHPort int `env:"CHARM_SSH_PORT" envDefault:"35353"`
HTTPPort int `env:"CHARM_HTTP_PORT" envDefault:"35354"`
Debug bool `env:"CHARM_DEBUG" envDefault:"false"`
Logfile string `env:"CHARM_LOGFILE" envDefault:""`
KeyType string `env:"CHARM_KEY_TYPE" envDefault:"ed25519"`
DataDir string `env:"CHARM_DATA_DIR" envDefault:""`
IdentityKey string `env:"CHARM_IDENTITY_KEY" envDefault:""`
}
```
Source: [https://github.com/charmbracelet/charm/blob/main/client/client.go](https://github.com/charmbracelet/charm/blob/main/client/client.go#L28-L37)

Thanks for using the Charm Cloud and please chat us up in [Discord](https://charm.sh/chat) if you have any questions.

[glowv2]: https://github.com/charmbracelet/glow/releases/tag/v2.0.0
[skatev1]: https://github.com/charmbracelet/skate/releases/tag/v1.0.0

***

Charm
=====

Expand All @@ -13,8 +47,6 @@ Charm is a set of tools that makes adding a backend to your terminal-based
applications fun and easy. Quickly build modern CLI applications without
worrying about user accounts, data storage and encryption.

Charm powers terminal apps like [Glow][glow] and [Skate][skate].

## Features

* [**Charm KV:**](#charm-kv) an embeddable, encrypted, cloud-synced key-value store built on [BadgerDB][badger]
Expand Down
Loading