enbas/docs/getting-started.md

31 lines
1.3 KiB
Markdown
Raw Normal View History

# Getting Started
## Summary
In this guide we are going to log into an account on a private GoToSocial server.
Follow along to log into your own account.
## Your configuration directory
Enbas uses Go's [os.UserConfigDir()](https://pkg.go.dev/os#UserConfigDir) function to calculate the location of your configuration directory.
If you've set the `XDG_CONFIG_HOME` environment variable, the configuration directory will be set to `$XDG_CONFIG_HOME/enbas`.
If this is not set, then:
- on Linux the configuration directory will be set to `$HOME/.config/enbas`.
- on Darwin (MacOS) the configuration directory will be set to `$HOME/Library/Application Support/enbas`.
- on Windows the configuration directory will be set within the `%AppData%` directory.
Alternatively you can use the `--config-dir` global flag to specify your configuration directory.
## Generate your configuration file
Run `enbas init` to generate your configuration file.
View configuration file. JSON file, mostly blank slate for you to configure to your preferences. Configuration documentation coming soon. For this getting started guide you may want to specify your preferred browser to open the link to your instance's login page. Can leave blank if you prefer to open the link manually.
## Log into your GoToSocial account
## View your account information