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

Reorganize the settings page #57

Open
saubyk opened this issue Sep 6, 2020 · 3 comments
Open

Reorganize the settings page #57

saubyk opened this issue Sep 6, 2020 · 3 comments
Labels
enhancement New feature or request ui Visual design work ux User experience work

Comments

@saubyk
Copy link
Collaborator

saubyk commented Sep 6, 2020

The settings page design needs to be reorganized to separate the RTL level and Node level settings.

Settings (RTL Level):

  • Default node
  • Add new node
  • Authentication
  • SSO Settings (optional config) [Cookie path, Logout redirect link]

Node Config (Node level):

  • Fiat Currency conversion toggle
  • Application layout
  • Day/Night mode
  • Color Themes
  • Lightning server url
  • Swap server url (optional)
  • Swap service provider (future)
@saubyk saubyk added enhancement New feature or request ui Visual design work ux User experience work labels Sep 6, 2020
@ShahanaFarooqui
Copy link
Collaborator

  • Root Level Settings:
    • multiPass => Plain text password, mandatory, default 'password'
    • secret2fa => Secret key for two factor authentication, optional
    • host => Host for the rtl node server, optional, default 'localhost'
    • port => RTL node server port, mandatory, default '3000'
    • defaultNodeIndex => Sets the selected node on server restart, optional, default 1, allowed values List of node indices
    • SSO => Single Sign On settings, optional
      • rtlSSO => To turn SSO on/off, required, default '0', allowed values 0/1
      • rtlCookiePath => Cookie file path if SSO is on, optional, default ''
      • logoutRedirectLink => Link to re direct after user logs out from RTL, optional, default ''

  • Node Level Settings:
    • index => Unique index for the node, mandatory, starts from 1
    • lnNode => Name to identify unique node in the UI, mandatory, default 'Node 1'
    • lnImplementation => LNP implementation, mandatory, default 'LND', allowed values LND/CLT/ECL
    • Authentication => Authentication Settings
      • macaroonPath => Path for LNP macaroon, mandatory for LND/CLT,
      • lnApiPassword => Password to be used for ECL API authentication. mandatory for ECL if the configPath is missing
      • configPath => Full path of the LNP config file, optional (mandatory for ECL if the lnApiPassword is not set)
      • swapMacaroonPath => Path for loop macaroon, optional (mandatory only if swapServerUrl is set)
      • boltzMacaroonPath => Path for boltz macaroon, optional (mandatory only if boltzServerUrl is set)
    • Settings => UI Settings
      • userPersona => User persona, mandatory, allowed values 'MERCHANT'/'OPERATOR', default 'MERCHANT'
      • themeMode => Mode, mandatory, default 'DAY', allowed value 'DAY'/'NIGHT'
      • themeColor => Theme colors, mandatory, default 'PURPLE', allowed values 'PURPLE'/'TEAL'/'INDIGO'/'PINK'/'YELLOW'
      • channelBackupPath => Path to save channel backup file. optional (allowed for LND only, not allowed for CLT/ECL)
      • bitcoindConfigPath => Path of local bitcoind.conf
      • lndServerUrl => REST API url for the node, mandatory, default 'https://localhost:8080'
      • swapServerUrl => REST API url for loop, optional, default 'https://localhost:8081'
      • boltzServerUrl => REST API url for boltz, optional, default 'https://localhost:9003'
      • fiatConversion => Fiat conversion turn on/off, mandatory, default false, allowed values true/false
      • currencyUnit => Fiat current Unit for currency conversion, optional (required if fiatConversion is true), default 'USD'
      • enableLogging => To turn RTL logging off/on, mandatory, default false, allowed values true/false

@saubyk
Copy link
Collaborator Author

saubyk commented Jan 23, 2021

Settings menu and wireframes:

Settings menu click:
Node - Settings
Node settings:
Node - Settings Node
Authentication settings:
Node - Settings Auth

@saubyk
Copy link
Collaborator Author

saubyk commented Jan 23, 2021

Node Config wireframes.

Click on the 'Node Config' menu on the left navigation:
Node - Config
Services configuration:
Node - Config Services

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ui Visual design work ux User experience work
Projects
None yet
Development

No branches or pull requests

2 participants