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.

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

v1.19.0 - Updated readme steps & initial config setup fix #147

Merged
merged 6 commits into from
Oct 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 4 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Feel free to abuse this demo instance (nicely), which runs on the latest `dev` b

Currently only a [docker image](https://github.com/sbondCo/Watcharr/pkgs/container/watcharr) is provided (**v1.9.1 and newer no longer require the `watcharr-ui` package, it is bundled inside the main `watcharr` package**).

**Note:** When first running, make sure only you have access. The first user created will become admin.

Here is a simple setup you can use yourself, using docker compose:

**docker-compose.yml**
Expand All @@ -55,41 +57,13 @@ services:
ports:
- 3080:3080
volumes:
# .env file used to configure watcharr
- .env:/.env
# Contains all of watcharr data (database & cache)
- ./data:/data
```

**.env**
After loading up Watcharr, you will be greeted with a menu to setup the first account (which will be admin).

```
# Used to sign JWT tokens. Make sure to make
# it strong, just like a very long, complicated password.
JWT_SECRET=MAKE_ME_RANDOM_AND_LONG

# Optional: Point to your Jellyfin install
# to enable it as an auth provider.
JELLYFIN_HOST=https://my.jellyfin.example

# Enable/disable signup functionality.
# Set to `false` to disable registering an account.
SIGNUP_ENABLED=true

# Optional: Provide your own TMDB API Key.
# If unprovided, the default Watcharr API key will be used.
# TMDB_KEY=

# Enable/disable debug logging. Useful for when trying
# to figure out exactly what the server is doing at a point
# of failure.
# Set to `true` to enable.
DEBUG=false

# Optional: When not set we assume production, should only
# be set to DEV when developing the app.
MODE=prod
```
When logged in you can then configure the server settings from the nav face menu > settings option.

# Getting Help

Expand Down
1 change: 0 additions & 1 deletion docker-compose.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ services:
ports:
- 3080:3080
volumes:
- ./server/.env:/.env
- ./container_data:/data
1 change: 0 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@ services:
ports:
- 3080:3080
volumes:
- ./server/.env:/.env
- ./container_data:/data
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "watcharr",
"version": "1.18.0",
"version": "1.19.0-dev1",
"private": true,
"scripts": {
"dev": "vite dev",
Expand Down
2 changes: 1 addition & 1 deletion server/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ func generateConfig() error {
if err != nil {
return err
}
Config = cfg
Config.JWT_SECRET = cfg.JWT_SECRET
return os.WriteFile("./data/watcharr.json", barej, 0755)
}

Expand Down