Skip to content

Commit

Permalink
[bugfix]: default go libsecret, support changing secret store (#493)
Browse files Browse the repository at this point in the history
* [bugfix]: default go libsecret, support changing secret store

* update readme and rename libsecret
  • Loading branch information
kgarner7 authored Feb 9, 2024
1 parent 92478b5 commit 0a658e3
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 2 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ docker run --name feishin -p 9180:9180 feishin
2. After restarting the app, you will be prompted to select a server. Click the `Open menu` button and select `Manage servers`. Click the `Add server` button in the popup and fill out all applicable details. You will need to enter the full URL to your server, including the protocol and port if applicable (e.g. `https://navidrome.my-server.com` or `http://192.168.0.1:4533`).

- **Navidrome** - For the best experience, select "Save password" when creating the server and configure the `SessionTimeout` setting in your Navidrome config to a larger value (e.g. 72h).
- **Linux users** - The default password store uses `libsecret`. `kwallet4/5/6` are also supported, but must be explicitly set in Settings > Window > Passwords/secret score.

3. _Optional_ - If you want to host Feishin on a subpath (not `/`), then pass in the following environment variable: `PUBLIC_PATH=PATH`. For example, to host on `/feishin`, pass in `PUBLIC_PATH=/feishin`.

Expand Down
2 changes: 2 additions & 0 deletions src/i18n/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,8 @@
"mpvExecutablePath_description": "sets the path to the mpv executable",
"mpvExecutablePath_help": "one per line",
"mpvExtraParameters": "mpv parameters",
"passwordStore": "passwords/secret store",
"passwordStore_description": "what password/secret store to use. change this if you are having issues storing passwords.",
"playbackStyle": "playback style",
"playbackStyle_description": "select the playback style to use for the audio player",
"playbackStyle_optionCrossFade": "crossfade",
Expand Down
6 changes: 6 additions & 0 deletions src/main/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ if (store.get('ignore_ssl')) {
app.commandLine.appendSwitch('ignore-certificate-errors');
}

// From https://github.com/tutao/tutanota/commit/92c6ed27625fcf367f0fbcc755d83d7ff8fde94b
if (isLinux() && !process.argv.some((a) => a.startsWith('--password-store='))) {
const paswordStore = store.get('password_store', 'gnome-libsecret') as string;
app.commandLine.appendSwitch('password-store', paswordStore);
}

let mainWindow: BrowserWindow | null = null;
let tray: Tray | null = null;
let exitFromTray = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export const ApplicationSettings = () => {
localSettings.fontError(onFontError);

return () => {
ipc!.removeAllListeners('custom-font-error');
ipc?.removeAllListeners('custom-font-error');
};
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import { SelectItem } from '@mantine/core';
import isElectron from 'is-electron';
import { useTranslation } from 'react-i18next';
import { useSettingsStoreActions, useGeneralSettings } from '../../../../store/settings.store';
import {
SettingsSection,
SettingOption,
} from '/@/renderer/features/settings/components/settings-section';
import { Select } from '/@/renderer/components';

const localSettings = isElectron() ? window.electron.localSettings : null;

const PASSWORD_SETTINGS: SelectItem[] = [
{ label: 'libsecret', value: 'gnome_libsecret' },
{ label: 'KDE 4 (kwallet4)', value: 'kwallet' },
{ label: 'KDE 5 (kwallet5)', value: 'kwallet5' },
{ label: 'KDE 6 (kwallet6)', value: 'kwallet6' },
];

export const PasswordSettings = () => {
const { t } = useTranslation();
const settings = useGeneralSettings();
const { setSettings } = useSettingsStoreActions();

const updateOptions: SettingOption[] = [
{
control: (
<Select
aria-label={t('setting.passwordStore')}
clearable={false}
data={PASSWORD_SETTINGS}
defaultValue={settings.passwordStore ?? 'gnome_libsecret'}
disabled={!isElectron()}
onChange={(e) => {
if (!e) return;
localSettings?.set('password_store', e);
setSettings({
general: {
...settings,
passwordStore: e,
},
});
}}
/>
),
description: t('setting.passwordStore', {
context: 'description',
postProcess: 'sentenceCase',
}),
isHidden: !isElectron(),
title: t('setting.passwordStore', { postProcess: 'sentenceCase' }),
},
];

return <SettingsSection options={updateOptions} />;
};
10 changes: 10 additions & 0 deletions src/renderer/features/settings/components/window/window-tab.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ import { Divider, Stack } from '@mantine/core';
import { UpdateSettings } from '/@/renderer/features/settings/components/window/update-settings';
import { WindowSettings } from '/@/renderer/features/settings/components/window/window-settings';
import { DiscordSettings } from '/@/renderer/features/settings/components/window/discord-settings';
import isElectron from 'is-electron';
import { PasswordSettings } from '/@/renderer/features/settings/components/window/password-settings';

const utils = isElectron() ? window.electron.utils : null;

export const WindowTab = () => {
return (
Expand All @@ -11,6 +15,12 @@ export const WindowTab = () => {
<DiscordSettings />
<Divider />
<UpdateSettings />
{utils?.isLinux() && (
<>
<Divider />
<PasswordSettings />
</>
)}
</Stack>
);
};
4 changes: 3 additions & 1 deletion src/renderer/store/settings.store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ export interface SettingsState {
externalLinks: boolean;
followSystemTheme: boolean;
language: string;
passwordStore?: string;
playButtonBehavior: Play;
resume: boolean;
showQueueDrawerButton: boolean;
Expand Down Expand Up @@ -288,6 +289,7 @@ const initialState: SettingsState = {
externalLinks: true,
followSystemTheme: false,
language: 'en',
passwordStore: undefined,
playButtonBehavior: Play.NOW,
resume: false,
showQueueDrawerButton: false,
Expand Down Expand Up @@ -600,7 +602,7 @@ export const useSettingsStore = create<SettingsSlice>()(
return merge(currentState, persistedState);
},
name: 'store_settings',
version: 7,
version: 8,
},
),
);
Expand Down

0 comments on commit 0a658e3

Please sign in to comment.