Struct atomic_server_lib::config::Opts

pub struct Opts {

    pub command: Option<Command>,
    pub initialize: bool,
    pub rebuild_indexes: bool,
    pub development: bool,
    pub domain: String,
    pub port: u32,
    pub port_https: u32,
    pub ip: IpAddr,
    pub https: bool,
    pub https_dns: bool,
    pub email: Option<String>,
    pub script: String,
    pub config_dir: Option<PathBuf>,
    pub data_dir: Option<PathBuf>,
    pub public_mode: bool,
    pub server_url: Option<String>,
    pub log_level: LogLevel,
    pub trace: Tracing,
    pub slow_mode: bool,
}

Store and share Atomic Data! Visit https://atomicdata.dev for more info. Pass no subcommands to launch the server. The .env of your current directory will be read.

Fields

command: Option<Command>

The subcommand being run

initialize: bool

Recreates the /setup Invite for creating a new Root User. Also re-runs various populate commands, and re-builds the index

rebuild_indexes: bool

Re-builds the indexes. Parses all the resources. Do this when updating requires it, or if you have issues with Collections / Queries / Search.

development: bool

Use staging environments for services like LetsEncrypt

domain: String

The origin domain where the app is hosted, without the port and schema values.

port: u32

The port where the HTTP app is available. Set to 80 if you want this to be available on the network.

port_https: u32

The port where the HTTPS app is available. Set to 443 if you want this to be available on the network.

ip: IpAddr

The IP address of the server. Set to :: if you want this to be available to other devices on your network.

https: bool

Use HTTPS instead of HTTP. Will get certificates from LetsEncrypt fully automated.

https_dns: bool

Initializes DNS-01 challenge for LetsEncrypt. Use this if you want to use subdomains.

email: Option<String>

The contact mail address for Let’s Encrypt HTTPS setup

script: String

Custom JS script to include in the body of the HTML template

config_dir: Option<PathBuf>

Path for atomic data config directory. Defaults to “~/.config/atomic/”“

data_dir: Option<PathBuf>

Path for atomic data store folder. Contains your Store, uploaded files and more. Default value depends on your OS.

public_mode: bool

CAUTION: Skip authentication checks, making all data publicly readable. Improves performance.

server_url: Option<String>

The full URL of the server. It should resolve to the home page. Set this if you use an external server or tunnel, instead of directly exposing atomic-server. If you leave this out, it will be generated from domain, port and http / https.

log_level: LogLevel

How much logs you want. Also influences what is sent to your trace service, if you’ve set one (e.g. OpenTelemetry)

trace: Tracing

How you want to trace what’s going on with the server. Useful for monitoring performance and errors in production. Combine with log_level to get more or less data (trace is the most verbose)

slow_mode: bool

Introduces random delays in the server, to simulate a slow connection. Useful for testing.

Trait Implementations

impl Args for Opts

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl Clone for Opts

fn clone(&self) -> Opts

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for Opts

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Opts

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Opts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Opts

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.