Struct ServerConfig 

pub struct ServerConfig<ServerSpecific> {
    pub port: u16,
    pub ips: Box<[IpAddr]>,
    pub bind_to: Skip,
    pub self_check_code: Option<String>,
    pub jwt_key: Option<SigningKey>,
    pub enc_key: Option<PrivateKey>,
    pub admin_key: Option<VerifyingKey>,
    pub object_store: Option<ObjectStoreConfig>,
    pub version: Option<String>,
    extra: ServerSpecific,
}

Configuration for one server. Derefs to ServerSpecific..

Fields

port: u16

Port to bind this server to

ips: Box<[IpAddr]>

Ip addresses to bind to

bind_to: Skip

Deprecated.

self_check_code: Option<String>

Random string used by this server to identify itself. Randomly generated if not set. May be set manually when multiple instances of the same server are used.

jwt_key: Option<SigningKey>

Key used to sign JSON web tokens generated by this server. If None, one is generated automatically (which is not suitable for production.)

Generate using cargo run tools generate signing-key.

enc_key: Option<PrivateKey>

Each server advertises an elgamal::PublicKey so that shared secrets may be established with this server, and also encrypted messages may be sent to it.

This key is also used to derive non-permanent secrets, like the the transcryptor’s encryption factor f_H for a hub H.

Generate using cargo run tools generate scalar.

admin_key: Option<VerifyingKey>

Key used by admin to sign requests for the admin endpoints. If None, one is generated automatically and the private key is printed to the log.

object_store: Option<ObjectStoreConfig>

If the server needs an object store, use this one.

version: Option<String>

What version (if any) to claim this pubhubs binary is running. Uses crate::servers::version() by default. Should only be used for troubleshooting/debugging.

extra: ServerSpecific

Can be accessed via Deref.

Trait Implementations

impl<ServerSpecific: Clone> Clone for ServerConfig<ServerSpecific>

fn clone(&self) -> ServerConfig<ServerSpecific>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ServerSpecific: Debug> Debug for ServerConfig<ServerSpecific>

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

Formats the value using the given formatter.

impl<X> Deref for ServerConfig<X>

type Target = X

The resulting type after dereferencing.

fn deref(&self) -> &X

Dereferences the value.

impl<X> DerefMut for ServerConfig<X>

fn deref_mut(&mut self) -> &mut X

Mutably dereferences the value.

impl<'de, ServerSpecific> Deserialize<'de> for ServerConfig<ServerSpecific>

where ServerSpecific: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Extra: PrepareConfig<Rc<Extensions>> + GetServerType> PrepareConfig<Rc<Extensions>> for ServerConfig<Extra>

async fn prepare(&mut self, c: Rc<Extensions>) -> Result<()>

impl<ServerSpecific> Serialize for ServerConfig<ServerSpecific>

where ServerSpecific: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, X> ToSocketAddrs for &'a ServerConfig<X>

type Iter = Box<dyn Iterator<Item = SocketAddr> + 'a>

Returned iterator over socket addresses which this type may correspond to.

fn to_socket_addrs(&self) -> Result<Self::Iter>

Converts this object to an iterator of resolved SocketAddrs.